Перейти к содержанию

Массовое создание скриптов интеграции

Запрос

Тип Метод
POST /integration_scripts/mass_create

Описание: метод создаёт несколько скриптов интеграции из переданного списка.

Каждый объект обрабатывается отдельно. Перед созданием выполняется валидация объекта. Если при обработке отдельного объекта возникает ошибка, информация о ней возвращается в поле error соответствующего элемента массива results.

Если при создании объекта возникает ошибка уникального ограничения, выполняется обновление существующего объекта по полям уникального ограничения, которые вызвали ошибку.

Пример запроса

POST

https://development.gigantic-server.com/v1/integration_scripts/mass_create

Тело запроса:

Параметр Тип данных Обязательность Описание
items Array<object> Required Список скриптов интеграции для создания

Каждый элемент массива items соответствует структуре IntegrationScriptsCreate, используемой при создании активного действия для типа интеграции.

Пример тела запроса

{
  "items": [
    {
      "<параметр>": "<значение>"
    },
    {
      "<параметр>": "<значение>"
    }
  ]
}

Примечание: Полный перечень параметров объекта items см. в разделе Создание активного действия для типа интеграции.

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Параметры ответа:

Параметр Тип данных Описание
results Array<object> Список результатов обработки объектов
results[].result IntegrationAction или null Созданный или обновлённый объект
results[].error string или null Текст ошибки обработки объекта

Для каждого элемента массива items возвращается отдельный результат обработки:

  • при успешном создании или обновлении поле result содержит созданный или обновлённый объект;
  • при ошибке поле error содержит описание ошибки обработки объекта.
Пример ответа

{
  "results": [
    {
      "result": {
        "<параметр>": "<значение>"
      },
      "error": null
    },
    {
      "result": null,
      "error": "<текст ошибки>"
    }
  ]
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Ошибка в теле запроса или при его обработке
401 can't get user info: Невозможно аутентифицировать пользователя
500 Internal Server Error Ошибка сервера

Возможные ошибки:

  • 400 — "Bad Request" — неверный тип параметра запроса либо отсутствует обязательный параметр;
  • 400 — "read body: ..." — ошибка чтения тела запроса;
  • 400 — "empty items" — список объектов не передан или пуст;
  • 400 — "parse request: ..." — ошибка парсинга запроса;
  • 400 — "parse request to map: ..." — ошибка парсинга запроса в карту;
  • 401 — "can't get user info:" — невозможно аутентифицировать пользователя;
  • 500 — "Internal Server Error" — ошибка сервера.