Перейти к содержанию

Поиск ПО

Запрос

Тип Метод
POST /software/search

Описание: При выполнении запроса будут возвращены найденные объекты с учётом заданных фильтров.

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

POST
http://127.0.0.1/cruddy/v2/software/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 Поле для поиска по подстроке по всем строковым полям модели и настройка строгого поиска
relations Array<string> Required Список связей для выборки. Список доступных связей отображается в ответе запроса на получение метаданных - “/_meta”
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
negation boolean Optional Флаг использования отрицания при проверке фильтра

Для получения списка установленного ПО нужно задать фильтр со следующими параметрами:

{
    "filter_type": "related",
    "field": "service_assets",
    "negation": true,
    "value": []
}

Чтобы получить неустановленное ПО, нужно указать в фильтре "negation": false.

Array of ordering
Параметр Тип Обязательность Описание / Допустимые значения
field string Required Поле модели выбранное для сортировки
direction string Required Направление сортировки. Допустимые значения:
- asc
- desc
Параметр Тип Обязательность Описание / Допустимые значения
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 <Software> Список найденных записей о ПО
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",
      "trace_id": "uuid",
      "name": "string",
      "raw_output_line": "string",
      "version": "string",
      "release": "string",
      "os": "string",
      "display_name": "string",
      "description": "string",
      "software_group_id": "d7939ec9-4754-44e2-b522-27172eae4658",
      "tsvector": "'17':4,12 '17.5.2.1':8,16,17 'driver':3,11 'for':5,13 'microsoft':1,9 'odbc':2,10 'server':7,15 'sql':6,14",
      "assets_count": 0,
      "is_group": true,
      "software_count": 0,
      "software_group": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_at": "2023-12-20T00:00:01.652259Z",
        "updated_at": "2023-12-20T00:00:01.652259Z",
        "trace_id": "uuid",
        "name": "Новая группа ПО",
        "description": "Описание новой группы ПО",
        "add_new_software_versions": false
      },
      "service_assets": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created_at": "2023-12-20T00:00:01.652259Z",
          "updated_at": "2023-12-20T00:00:01.652259Z",
          "trace_id": "uuid",
          "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"
        }
      ],
      "_relations": {
        "service_assets": [
          "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
}