Запрос

POST /pub/v1/scheme/groups/list

Тело запроса (body)

Тело запроса принимает ресурс  Получение списка схем групп согласно условиям фильтрации — Request. Содержит следующие доступные для записи свойства:

{
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "string"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Свойства

Имя Тип Описание Дополнительно
filter object

Фильтрация

Опциональное
filter.<key> map of object Опциональное
from int64

Начальный индекс возвращаемых элементов (offset)

Опциональное
ids[] array of string

Фильтрация по идентификаторам

Опциональное
size int64

Количество возвращаемых элементов

Опциональное
sortExpressions[] array

Правила сортировки

Опциональное
sortExpressions[].ascending boolean

Признак сортировки по возрастанию

Опциональное
sortExpressions[].field string

Поле сортировки

Опциональное

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP:

HTTP-статус Описание Модель ответа
200 OK

Модель ответа на получение списка схем групп согласно условиям фильтрации

Модель ответа на получение списка схем групп согласно условиям фильтрации (Получение списка схем групп согласно условиям фильтрации)