Массовое обновление типов инцидентов
Запрос
Тип | Метод |
---|---|
POST |
/findings/mass_update |
Описание: При выполнении запроса выбранным параметрам типов инцидентов будут присвоены новые значения.
Работает по принципу частичного обновления, т.е. будут обновлены только те поля модели которые были переданы в запросе.
Всем объектам будут присвоены одинаковые значения в переданных полях.
Изменение связей не поддерживается.
Метод транзакционный, если произошла ошибка изменения одного из объектов, откатываются все изменения.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/findings/mass_update
Тело запроса:
Параметр | Тип данных | Обязательность | Описание |
---|---|---|---|
ids | Array<string> |
Required | Список ID объектов |
fields | DefaultObject |
Required | Словарь новых значений полей модели Finding |
fields{param_1} | Зависит от изменяемого параметра в соответствии с моделью | Optional | Первый параметр, который необходимо изменить в соответствии с моделью объекта, например title |
fields{param_n} | Зависит от изменяемого параметра в соответствии с моделью | Optional | N-ый параметр, который необходимо изменить в соответствии с моделью объекта, например description |
Пример тела запроса
{
"ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"fields": {
"title": "string",
"description": "string",
"risk_impact": "string",
"solution": "string",
"display_id": 0,
"mitigation": "string",
"synopsis": "string",
"local": true,
"type": "network_anomaly",
"identifier": {},
"comment": "string",
"fallback_raw_risklevel": 10,
"new_version": true,
"client_note": "string",
"internal_note": "string",
"cpes": [
"string"
],
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"customer_created": true,
"software_compliance": true,
"itsm_last_synced_at": "2023-12-20T00:00:01.652259Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"created_by_customer": "d299b51b-03f1-4b72-b793-1fb027d05389",
"edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
"is_system": true
}
}
Успешный ответ
Статус код: 200
– объекты успешно изменены.
Другие возможные ответы
Код | Ответ | Описание |
---|---|---|
400 |
1. Bad Request 2. ids is empty 3. fields is empty 4. exceeded maximum length for a value 5. id should be uuid format |
1. Неверный тип параметра запроса, либо отсутствует обязательный параметр 2. Список ID не передан 3. Новые значения полей не переданы 4. Значение превышает максимально допустимую длину 5. Недопустимый формат ID |
404 |
not found |
Объект не найден |
409 |
name_already_used |
Попытка создать объект с существующим уникальным атрибутом |
500 |
Internal Server Error |
Другие ошибки сервера |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{ "error": "Bad Request", "error_code": 400 }
Код 404
{ "error": "Not Found", "error_code": 404 }
Код 409
{ "error": "name_already_used", "error_code": 409, "extra": { "fields": [ "name" ] } }
Код 500
{ "error": "Internal Server Error", "error_code": 500 }