Обновление экземпляра интеграции

Запрос

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

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

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

Path параметры запроса:

Параметр	Тип данных	Обязательность	Описание
integration_id	string	Required	Идентификатор экземпляра интеграции

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

PUT

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

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

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

Параметр	Тип	Обязательность	Описание
id	string	Required	Идентификатор экземпляра интеграции в формате uuid
created_at	string	Required	Дата создания в формате date-time
updated_at	string	Required	Дата изменения в формате date-time
integration_type_id	string	Required	Идентификатор типа интеграции
integration_name	string	Required	Наименование экземпляра интеграции
state	boolean	Required	Состояние экземпляра интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен.
params	Array<Params>	Required	Параметры интеграции

Params

Параметр	Тип	Обязательность	Описание
host	string	Required	Адрес API сервера
port	integer	Required	Порт
login	string	Required	Логин для подключения к серверу
password	string	Required	Пароль
is_jobs_active	boolean	Required	Использовать ли периодические задачи синхронизации: true, false
is_actions_active	boolean	Required	Использовать ли активные действия: true, false

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
  "integration_name": "Ростех-EDR Роснефть-Нижневартовск",
  "state": true,
  "params": {
    "host": "string",
    "port": 0,
    "login": "string",
    "password": "string",
    "is_jobs_active": true,
    "is_actions_active": true
  }
}

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

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

Формат: JSON.

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

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
  "integration_name": "Ростех-EDR Роснефть-Нижневартовск",
  "state": true,
  "params": {
    "host": "string",
    "port": 0,
    "login": "string",
    "password": "string",
    "is_jobs_active": true,
    "is_actions_active": true
  }
}

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

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

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

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

   
Код 400
   

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



   
Код 500
   

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