Получение значений дополнительных полей по ID связанного с ними инцидента
Запрос
Тип | Метод |
---|---|
GET |
/custom_field_values/by_saf_id/{saf_id} |
Описание: При выполнении запроса будет возвращено значение дополнительного поля по ID связанного инцидента и ключу custom_fields.field_key, по одному для каждого значения ключа, с самой свежей датой создания.
Пример запроса
GET
http://127.0.0.1/cruddy/v2/custom_field_values/by_saf_id/{saf_id}
Path параметры запроса:
Параметр | Описание |
---|---|
{saf_id} | Идентификатор связанного инцидента |
Успешный ответ
Статус код: 200
– успешный ответ.
Формат: JSON
.
Параметры ответа:
Параметр | Тип данных | Описание |
---|---|---|
items | Array <CustomFieldValue> |
Список найденных значений дополнительных полей |
total | integer |
Количество найденных значений дополнительных полей |
Пример ответа
{
"items": [
{
"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,
"field_type": "string",
"occurrence_id": "8508ee33-23a1-4a06-ae02-1eb167405e7b",
"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
},
"occurrences": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"event_type": "manual_source",
"ip": "string",
"mac": "string",
"port": 0,
"start_occurrence": "2023-12-20T00:00:01.652259Z",
"end_occurrence": "2023-12-20T00:00:01.652259Z",
"service_asset_finding_status_change_id": "8d6bf02f-aab2-4fbc-ab53-ee5963306be7",
"service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
"fqdn": "string",
"incident_identifier": "string",
"fincert_sync_status": 10,
"fincert_id": "",
"sopka_sync_status": 10,
"sopka_id": "",
"fincert_sync_result": "7325f612-d464-4395-bb86-c83b3b6893fb",
"sopka_sync_result": "d91aad7a-d9ad-4941-bf19-b94f42afada9"
}
],
"_relations": {
"occurrences": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}
],
"total": 1
}
Другие возможные ответы
Код | Ответ | Описание |
---|---|---|
400 |
id is empty |
Не передан параметр “id” |
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 }