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

Создание активного действия в типе интеграции

Запрос

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

Описание: При выполнении запроса будет создано новое активное действия в типе интеграции. После создания, оно будет доступно во всех экземплярах интеграции, созданных в рамках типа интеграции.

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

POST

Development server
https://development.gigantic-server.com/v1/integration_scripts/create

Staging server
https://staging.gigantic-server.com/v1/integration_scripts/create

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

Параметр Тип Обязательность Описание
integration_type_id string Required Идентификатор типа интеграции в формате uuid
name string Required Название активного действия
script_lin string Optional Скрипт активного действия для ОС Linux
script_win string Optional Скрипт активного действия для ОС Windows
state boolean Required Глобальное состояние скрипта (вкл/выкл) для всех экземпляров платформы
params Array<object> Required Список параметров для запуска скрипта
params{parameter_name} string Required Имя передаваемого для запуска скрипта параметра
params{parameter_value} string Required Что необходимо передать в качестве значения параметра (поле события)
params{from_event} boolean Required Берётся ли значение параметра из поля события или ручной ввод значения
Пример тела запроса

{
  "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
  "name": "Заблокировать процесс по его ID",
  "script_lin": "block_windows_process_by_pid.sh",
  "script_win": "block_windows_process_by_pid.bat",
  "state": true,
  "params": [
    {
      "parameter_name": "pid",
      "parameter_value": "{event.execution.process.id}",
      "from_event": true
    }
  ]
}

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

Статус код: 201 – успешное добавление.

Формат: JSON

Тело ответа: модель активного действия для типа интеграции.

Пример ответа

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
  "name": "string",
  "params": [
    {
      "parameter_name": "pid",
      "parameter_value": "{event.execution.process.id}",
      "from_event": true
    }
  ],
  "scripts_win": "string",
  "scripts_lin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, либо отсутствует обязательный параметр
500 Internal Server Error Другие ошибки при удалении объектов

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа
Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}