Обновление активного действия в интеграции

Запрос

Тип	Метод
PUT	/integration_actions/update

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

Работает по принципу частичного обновления, т.е. будут обновлены только те поля модели которые были переданы в запросе.

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

PUT

Development server
https://development.gigantic-server.com/v1/integration_actions/update

Staging server
https://staging.gigantic-server.com/v1/integration_actions/update

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

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор активного действия в формате uuid
integration_id	string	Required	Идентификатор экземпляра интеграции в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
state	boolean	Required	Состояние скрипта Вкл/выкл
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	Берётся ли значение параметра из поля события или ручной ввод значения

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "state": true,
  "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",
  "params": [
    {
      "parameter_name": "pid",
      "parameter_value": "{event.execution.process.id}",
      "from_event": true
    }
  ]
}

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

Статус код: 200 – успешное обновление информации об активном действии.

Формат: JSON.

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

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "integration_id": "55d7337e-1d0a-49fc-9826-925ba40df035",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "state": true,
  "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",
  "params": [
    {
      "parameter_name": "pid",
      "parameter_value": "{event.execution.process.id}",
      "from_event": true
    }
  ]
}

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

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

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

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

   
Код 400
   

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



   
Код 500
   

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