Публичный Web API: Получение списка элементов приложения

Запрос

POST /pub/v1/app/{namespace}/{code}/list

Параметры пути (path)

Имя параметра	Тип	Описание	Дополнительно
namespace	string	Код раздела	Обязательный
code	string	Код приложения	Обязательный

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

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

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

Свойства

Имя	Тип	Описание	Дополнительно
active	boolean	Показывать только активные (не удаленные)	Опциональное
fields	object	Правила загрузки полей	Опциональное
filter	object	Фильтрация	Опциональное
filter.<key>	map of object		Опциональное
from	int64	Возвращать начиная с элемента	Опциональное
ids[]	array of uuid	Фильтрация по идентификаторам	Опциональное
size	int64	Количество возвращаемых элементов (максимум 10000)	Опциональное
sortExpressions[]	array	Правила сортировки	Опциональное
sortExpressions[].ascending	boolean	Признак сортировки по возрастанию	Опциональное
sortExpressions[].field	string	Поле сортировки	Опциональное
statusCode[]	array of string	Показывать элементы определенных статусов	Опциональное
statusGroupId	uuid	Показывать элементы определённой группы статусов	Опциональное

Авторизация

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

Ответ

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

HTTP-статус	Описание	Модель ответа
200	OK Модель списка элементов приложения	Модель списка элементов приложения (Получение списка элементов приложения)