Обновление значения дополнительного поля

Запрос

Тип	Метод
`PUT`	`/custom_field_values/update`

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

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

Позволяет также управлять связями многие ко многим с другими моделями через поле _relations.

Ключами в поле _relations могут быть названия полей моделей ссылающиеся на другие. Например если у модели связь с моделью правил корреляции и в нем хранится объект связанного правила то это поле можно использовать при управлении данной связью.

Управление работает следующим образом:

Если поля в объекте _relations отсутствуют зависимости не обновляются.
Если поле зависимости указано и в значении не пустой список идентификаторов, то связи модели приводятся к описанному состоянию.
Если поле зависимости указано и в значении пустой список то все связи удаляются.
Зависимости игнорируются в теле запроса.
Зависимости в ответе всегда null.

Например следующий запрос:

{
  "id": "uuid",
  ...
  "_relations": {
    "logmule_go_rules": [] // - очистит все связи с правилами
    // "logmule_go_rules": ["uuid1", "uuid2"] // - создаст связь с 2 правилами
    // "logmule_go_rules": ["uuid1"] // - оставит связь только с первым правилом
  }
}

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


PUT
http://127.0.0.1/cruddy/v2/custom_field_values/update

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

Параметр	Тип данных	Обязательность	Описание
id	`string`	Required	Идентификатор значения дополнительного поля
created_at	`string`	Required	Дата создания значения дополнительного поля
updated_at	`string`	Required	Дата изменения информации о значении дополнительного поля
custom_field_id	`string`	Required	Идентификатор дополнительного поля
service_asset_finding_id	`string`	Required	Идентификатор инцидента
string_value	`string`	Optional	Значение дополнительного поля с типом данных "строка"
integer_value	`integer`	Optional	Значение дополнительного поля с типом данных "целое число"
float_value	`number`	Optional	Значение дополнительного поля с типом данных "число с плавающей запятой"
date_value	`date`	Optional	Значение дополнительного поля с типом данных "дата"
json_value	`string`	Optional	Значение дополнительного поля с типом данных "JSON"
boolean_value	`boolean`	Optional	Значение дополнительного поля с типом данных "логический"

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


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "custom_field_id": "a0fa4fc5-cabd-4219-9751-6d126c809065",
  "service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
  "string_value": "string",
  "integer_value": 0,
  "float_value": 0,
  "date_value": "2023-12-20T00:00:01.652259Z",
  "json_value": {},
  "boolean_value": true
}

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

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

Формат: JSON.

Тело ответа: модель обновленного значения дополнительного поля.

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


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "custom_field_id": "a0fa4fc5-cabd-4219-9751-6d126c809065",
  "service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
  "string_value": "string",
  "integer_value": 0,
  "float_value": 0,
  "date_value": "2023-12-20T00:00:01.652259Z",
  "json_value": {},
  "boolean_value": true,
  "custom_field": {
    "field_key": "string",
    "title": "string",
    "field_type": "string",
    "order_direction": 0
  },
  "service_asset_finding": {
    "description": "string",
    "risk_impact": "string",
    "solution": "string",
    "mitigation": "string",
    "status": "assigned_customer",
    "risklevel": 0,
    "service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
    "finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe",
    "analysis_output": "string",
    "synopsis": "string",
    "title": "string",
    "risk": "none",
    "acknowledged_at": "2023-12-20T00:00:01.652259Z",
    "alert_type": "automatic",
    "client_note": "string",
    "internal_note": "string",
    "external": false,
    "immediate_action_score": 0,
    "throughput_period": "grace",
    "throughput_period_change": "2023-12-20T00:00:01.652259Z",
    "customer_created": false,
    "c_visible_since": "2023-12-20T00:00:01.652259Z",
    "c_visible_since_in_days": 0,
    "c_reopened_count": 0,
    "c_last_customer_status_change": "2023-12-20T00:00:01.652259Z",
    "logmule_identifier": "string",
    "c_remote_exploitable": true,
    "c_occurrence_count": 0,
    "с_customer_retention_time": 0,
    "last_occurrence_id": "92c2542a-a9bb-4370-b835-20b1c9ac1fe9",
    "itsm_last_synced_at": "2023-12-20T00:00:01.652259Z",
    "itsm_sync_status": "scheduled",
    "external_id": "string",
    "itsm_sync_error": "string",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
    "acknowledged_by": "57e93f65-9db5-4b3c-8761-f3edd8ac8276",
    "created_by_customer": "d299b51b-03f1-4b72-b793-1fb027d05389",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c",
    "incident_group_id": "5ce55b8d-2342-4286-bf58-bfe807f8c05c",
    "reopened_at": "2023-12-20T00:00:01.652259Z",
    "display_id": 0
  }
}

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

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

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

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

   
Код 400   

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



   
Код 404   

{
  "error": "Not Found",
  "error_code": 404
}



   
Код 500   

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