Для: Администраторы
Выполните импорт с использованием управляющего ключа.
Создайте запрос на импорт, загрузите CSV-файл и прикрепите его, затем проверьте каждую строку и повторите попытку для тех, которые не удалось импортировать.
В этой статье9 разделов
Прежде чем начать
На этой странице рассказывается о выполнении процесса импорта с использованием управляющего ключа. Это то же самое, что и в разделе Интеграция › Импорты. Все пути, связанные с файлами, указаны в разделе https://prd-api-manage.caseactive.com/v1/integration/<hub id>. Что касается столбцов файлов, то информацию о них можно найти в разделе Какие столбцы необходимы для каждого импорта.
Звонки
| Вызов | Что это делает |
|---|---|
POST /imports | Создается процесс импорта. |
GET /drive/private?import_id=<id>&media_group=docs&media_extension=csv | Предоставляет адрес для загрузки своего файла. |
PUT /imports/<import_id> | Записывается загруженный файл; это запускает процесс импорта. |
GET /imports | Перечислите все ваши импорты, начиная с самых последних. Также укажите прогресс в процессе импорта каждого товара. |
GET /imports/<import_id> | Перечисляет строки импорта. |
PUT /imports/<import_id>/<unique_id> | Попытка восстановления неудачной записи. |
1. Создайте импорт.
| Поле | Что это делает | Необходимый |
|---|---|---|
name | Название для этого: буквы, цифры, пробелы и знаки отрицания. | Да. |
source | Что является источником этого действия? Например, claims-sync. Это указано в административном панели. | Да. |
type | Один из типов ниже | Да. |
type | На экране |
|---|---|
post_user | Добавляем пользователей |
put_user | Изменение параметров пользователей |
post_case | Создайте случаи. |
put_case | Измените ситуации/обстоятельства |
post_case_permission | Назначьте пользователей к соответствующим случаям. |
delete_case_permission | Удалить пользователей, которые отвечают за работу с конкретными случаями. |
post_case_post | Создайте сообщения для случаев. |
curl -X POST https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "October claimants", "source": "claims-sync", "type": "post_user"}'
Это соответствие между 201 и import_id; например, import::20261002141503_3f9a1c2b7d4e60.
2. Загрузите файл.
Просьба предоставить адрес для загрузки файла. GET /drive/private?import_id=<import_id>&media_group=docs&media_extension=csv. Это ответ на вопрос. url И также набор из… fields. Отправьте файл туда в виде… multipart/form-data POST – с каждым записанным элементом. fields Точно так же, как указано в тексте; файл находится в конце списка. file:
curl -X POST "<url>" \
--form-string "key=<fields.key>" \
--form-string "<every other entry of fields, as given>" \
-F "file=@october-claimants.csv"
- Присылайте записи с
fieldsи--form-string, а не с-F. Некоторые из этих записей начинаются с<или содержат;. Слово-Fв таких случаях означает файл или опцию. - Этот адрес работает в течение часа.
- Сохраните файл в формате CSV с кодом кодирования UTF-8. В первой строке файла должны указываться имена столбцов.
- Файл может содержать до 25 000 строк под названиями колонок. Если количество строк превышает этот лимит, импорт файла не будет выполнен. Поэтому необходимо разделить файл на несколько файлов по 25 000 строк в каждом. После этого можно провести импорт данных для каждого из этих файлов отдельно.
- Сохраните
fields.key: это способ прикрепления файла в следующем шаге.
3. Прикрепите файл
PUT /imports/<import_id> – с помощью ключа загрузки начинается процесс импорта. Это соответствует значению 204.
{"media_key": "<fields.key>"}
Подайте файл один раз. Если процесс импорта не прошел успешно, исправьте файл и попробуйте снова.
4. Проверьте ход выполнения.
В таблице GET /imports перечислены все ваши импорты. Все значения расположены в порядке возрастания. Для каждого значения указаны соответствующие метки: status, total, passed и failed.
QUEUED: создано или прикреплено, но ещё не прочитано.PROCESSED: Файл был прочитан внутрь.totalРяды располагаются один за другим. Это завершение процесса происходит тогда, когда…passedиfailedВсе вместе составляют целое.total.FAILED: Файл не удалось прочитать. В нем не было строк, или количество строк превышало 25 000. Импорт произошел с использованием одного из следующих параметров:error_msg,ImportFileUnreadableException,ImportFileEmptyExceptionилиImportFileTooLargeException.
Ряды данных пересчитываются в вашем хабе каждые два импорта. Поэтому импорт большого файла занимает довольно много времени. Когда происходит неудача при импорте или при первом попытке импорта, администраторы и менеджеры вашего хаба получают сообщения по электронной почте.
В строке GET /imports/<import_id> перечислены строки, которые уже были обработаны, в том порядке, в котором они находятся в файле. В строке limit указано количество строк (до 1000). В строке start_key также указано количество строк.
{
"data": {
"items": [
{
"unique_id": "unique::20261002141503_3f9a1c2b7d4e60_0000002",
"line": 2,
"type": "post_user",
"status": "SUCCEEDED",
"data": {"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "host_ref_id": "cl-1042"},
"output": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60"}
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports/import::20261002141503_3f9a1c2b7d4e60"
}
}
| Поле | Что в нём содержится |
|---|---|
line | Номер строки в вашем файле. В таблице считаются строки; названия столбцов соответствуют первой строке. |
data | Клетки ряда, как они пришли. |
status | SUCCEEDED, FAILED или QUEUED – пока не будет произведен попытка повторения. |
output | Что это означает: user_id, case_id, или и то, и другое для строки, которая помогает кому-то попасть в какую-либо ситуацию. |
schema_errors | Для клетки, которая не прошла проверку: столбец, а также причины неудачи. |
error_msg | Почему этот запрос провалился? Какое же это ошибка… Например, CaseReferenceIdExistsException |
Строка считается успешной только в том случае, если она производит необходимые изменения. Строка, у которой идентификатор, номер реквизита или имя человека совпадают с данными другого записи, не может быть успешно обработана; в таком случае возникает ошибка. error_msg. Не удается назначить пользователей для работы с случаями или создать строки описания случаев, связанных с закрытыми случаями. {"_schema": ["Case is closed"]} внутри schema_errors: Необходимо снова открыть этот случай, а затем импортировать эту строку снова.
Ряды/Строки unique_id Это производится на основе идентификатора импорта и номера строки в вашем файле. Следовательно, речь идет о второй строке. import::20261002141503_3f9a1c2b7d4e60 есть unique::20261002141503_3f9a1c2b7d4e60_0000002.
5. Повторите попытку в следующем ряду.
PUT /imports/<import_id>/<unique_id> с {"retry": true} снова выполняет неудачный шаг процесса импорта. Это происходит в конце очереди обработки данных. Процесс отвечает на запросы 204, а количество элементов в файле failed уменьшается на одно единицу до тех пор, пока процесс не завершится. Этот метод используется для случаев неудачного выполнения процесса импорта по какой-либо причине – например, из-за перегрузки системы. Если содержимое ячеек файла неправильно, процесс снова неудачно выполняется. В таких случаях необходимо исправить ошибку в файле и начать новый процесс импорта.
Что произойдет дальше?
Ряды данных, полученные из источника, выполняют те же функции, что и ряды данных на экране: людей, добавленных в список, не отправляется сообщение по электронной почте; людей, добавленных в случае с приглашениями, также получают сообщение. Новые случаи делятся по правилам, установленным в системе; новые сообщения уведомляют людей, участвующих в этом случае. Полученные данные записываются как действия Виртуального помощникаВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника.. Опубликование одной и той же информации дважды приводит к повторному выполнению всех операций: если возникают проблемы с обработкой данных, сообщения будут опубликованы дважды. Чтобы исправить ошибки, связанные с некорректной обработкой данных на экране, смотрите раздел Исправление ошибок при импорте данных.
Если звонок отклонен
| Статус | message | Почему |
|---|---|---|
| 400 | SchemaFieldsException | В данном поле отсутствуют или имеются некорректные значения. Например, может быть такое поле типа name, в котором содержатся другие символы. Также может быть такое поле типа media_key, в котором ничего не загружено. |
| 403 | ImportFileAlreadyAttachedException | Принятое извлечение уже содержит соответствующий файл; или файл уже был прочитан. Начинаем новое извлечение. |
| 403 | BotNotAllowedException | Вы использовали символ /v1/<hub id>/imports вместо /v1/integration/<hub id>/imports. |
| 404 | ItemNotFoundException | Никакого значения не имеет, или нет никакой строки с таким идентификатором в вашем хабе. |