Поиск сообщений
Запрос
| Тип | Метод |
|---|---|
POST |
/messages/search |
Описание: При выполнении запроса будут возвращены найденные сообщения с учётом заданных фильтров.
По умолчанию в объекты не загружаются связанные модели по типам связи many2many и has-many, для включения загрузки их нужно указывать в поле relations объекта запроса.
Есть возможность расширить ответ информацией об идентификаторах связанных сущностей, возвращаемых в поле _relations, для этого необходимо и одноименном поле запроса передать список связанных моделей.
Поле _relations запроса расширяет поле relations для связей кроме один-к-одному, т.е. сущности, указанные в последнем поле, появятся в ответе в поле _relations в любом случае.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/messages/search
Тело запроса:
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| include_fields | Array<string> |
Required | Список полей для выборки. Если модель содержит поля, не указанные в запросе, они будут отсутствовать в ответе |
| exclude_fields | Array<string> |
Required | Список полей для удаления из выборки. Если модель содержит поля, указанные в запросе, они будут отсутствовать в ответе |
| filters | Array<filters> |
Required | Список фильтров по полям модели |
| ordering | Array<ordering> |
Required | Настройки сортировки |
| virtual_search | object<virtual_search> |
Required | Поле для поиска по подстроке по всем строковым полям модели и настройка строгого поиска |
| extension_params | object |
Optional | Флаги |
| extension_params{children_all} | boolean |
Optional | Получить всех детей |
| extension_params{parents_all} | boolean |
Optional | Получить всех родителей |
| relations | Array<string> |
Required | Список связей для выборки. Список доступных связей отображается в ответе запроса на получение метаданных - ”/_meta” Можно запрашивать многоуровневые связи. Например, если в запросе к активам указать "network_interfaces.services", погрузятся сетевые интерфейсы и их сервисы. |
| limit | integer |
Required | Лимит выдачи найденных объектов |
| offset | integer |
Required | Отступ от начала результата поиска в базе |
| _relations | Array<string> |
Optional | Перечисление связанных сущностей идентификаторы которых нужно вернуть в ответе в поле _relations |
Array of filters
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| field | string |
Required | Название поля модели |
| value | object |
Required | Значение для фильтрации |
| filter_type | string |
Required | В зависимости от этого значения определяется допустимые значения в поле value. Допустимые значения:- equal -> строка|число, проверяет равенство значений - substr -> строка, проверяет вхождение подстроки - intersection -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный массив - range -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный диапазон - related -> строка или массив строк (uuid), проверят связанность с моделью по идентификатору если value: [], проверяет наличие или отсутствие связанных сущностей- exists -> значение отсутствует, проверяется равенство колонки с null - contains -> строка|число, поле должно быть массивом, проверяет что переданное значение содержится в массиве - bitwise_and -> Получение всех объектов со всеми битовыми масками из value- bitwise_or -> Получение всех объектов с любыми из битовых масок из value |
| negation | boolean |
Optional | Флаг использования отрицания при проверке фильтра |
| extension_params | object |
Optional | Флаги |
| extension_params{children_all} | boolean |
Optional | Получить всех детей |
| extension_params{parents_all} | boolean |
Optional | Получить всех родителей |
Array of ordering
| Параметр | Тип | Обязательность | Описание / Допустимые значения |
|---|---|---|---|
| field | string |
Required | Поле модели выбранное для сортировки |
| direction | string |
Required | Направление сортировки. Допустимые значения: - asc - desc |
Object VirtualSearch
| Параметр | Тип | Обязательность | Описание / Допустимые значения |
|---|---|---|---|
| value | string |
Required | Значение выбранное для поиска |
| strict | boolean |
Required | Опция, включающая строгий поиск. Возможные значения: - true - строгий поиск включена;- false - строгий поиск выключен. |
Пример тела запроса
{
"include_fields": [
"string"
],
"exclude_fields": [
"string"
],
"filters": [
{
"field": "string",
"value": [
"name",
[
"value1",
"value2"
]
],
"filter_type": "equal",
"negation": false
}
],
"ordering": [
{
"field": "string",
"direction": "asc"
}
],
"virtual_search": {
"value": "string",
"strict": false
},
"relations": [
"service_asset_findings",
"logmule_go_rules",
"user"
],
"limit": 20,
"offset": 0,
"_relations": [
"string"
]
}
Успешный ответ
Статус код: 200 – успешный ответ.
Формат: JSON.
Параметры ответа:
| Параметр | Тип данных | Описание |
|---|---|---|
| items | Array<Message> |
Список найденных сообщений |
| 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",
"subject": "string",
"body": "string",
"service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
"service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
"service_asset_finding_status_change_id": "8d6bf02f-aab2-4fbc-ab53-ee5963306be7",
"automated": false,
"finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe",
"itsm_sync_status": "not_synced",
"itsm_last_synced_at": "string",
"itsm_sync_error": "string",
"sender_id": "3194e023-c19f-4a42-9172-9e18d68e3a3a",
"trace_id": "22f6dbcd-da6a-4c89-83c2-6b2013b21e15",
"owner_id": "93adf94b-0f93-45d1-8b3c-a15a38399d49",
"from": "admin",
"recipient_names": [
"admin",
"user"
],
"finding_display_id": 123,
"finding_title": "Множественные попытки входа",
"finding_type": "network_anomaly",
"finding_risklevel": 8,
"service_asset_finding_risklevel": 5,
"service_asset_finding_title": "Тестовый инцидент",
"saf_service_asset_id": "e07784df-df94-4296-a78d-d9db440c018e",
"service_asset_name": "string",
"incident_status": "assigned_customer",
"read": true,
"notifications": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"read": "string",
"forwarded_at": "string",
"message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
],
"service_asset": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"type": "Host",
"name": "Актив",
"description": "Описание актива",
"coordinates": "--- []",
"active": true,
"scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
"value": 3,
"client_note": "string",
"internal_note": "string",
"location": "string",
"network_exposure": 3,
"responsible_person": "string",
"technical_specialist": "string",
"responsible_group_id": "2d40d7ca-3218-4132-89ef-42e29379a567",
"edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c"
},
"service_asset_finding": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"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
},
"service_asset_finding_status_change": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"service_asset_finding_id": "08a5c673-3c5c-48ab-bf6c-f2ee47d8df88",
"status": "string",
"revisit_at": "string",
"itsm_sync_status": "not_synced",
"itsm_last_synced_at": "string",
"itsm_sync_error": "string",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
},
"finding": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"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
},
"sender": {
"id": "uuid",
"email": "string",
"first_name": "string",
"last_name": "string",
"username": "string"
},
"_relations": {
"notifications": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}
],
"total": 1
}
Другие возможные ответы
| Код | Ответ | Описание |
|---|---|---|
400 |
Bad Request |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
500 |
Internal Server Error |
Другие ошибки сервера |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{ "error": "Bad Request", "error_code": 400 }Код 500
{ "error": "Internal Server Error", "error_code": 500 }