Поиск дополнительных полей

Запрос

Тип	Метод
`POST`	`/custom_fields/search`

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

По умолчанию в объекты не загружаются связанные модели по типам связи many2many и has-many, для включения загрузки их нужно указывать в поле relations объекта запроса.

Связи _relations загружаются всегда и отражают текущее состояние связей модели.

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


POST
http://127.0.0.1/cruddy/v2/custom_fields/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	Флаг использования отрицания при проверке фильтра

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` <CustomField>	Список найденных дополнительных полей
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",
      "field_key": "string",
      "title": "string",
      "field_type": "string",
      "order_direction": 0,
      "custom_field_values": [
        {
          "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
        }
      ],
      "_relations": {
        "custom_field_values": [
          "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
}