Получение списка элементов контракта
Адрес запроса содержит код раздела, в котором содержится контракт ({namespace}
), и код самого контракта ({code}
).
Тело запроса содержит описание параметров запрашиваемого списка, которое задает фильтры и сортировку.
Запрос
POST /pub/v1/contracts/{namespace}/{code}/list
Параметры пути (path)
Имя параметра | Тип | Описание | Дополнительно |
---|---|---|---|
namespace | string | Код раздела |
Обязательный |
code | string | Код контракта |
Обязательный |
Тело запроса (body)
Тело запроса принимает ресурс Получение списка элементов контракта — Request. Содержит следующие доступные для записи свойства:
{
"active": "boolean",
"filter": {
"<key>": {}
},
"from": "int64",
"ids": [
"uuid"
],
"size": "int64",
"sortExpressions": [
{
"ascending": "boolean",
"field": "string"
}
]
}
Свойства
Имя | Тип | Описание | Дополнительно |
---|---|---|---|
active | boolean |
Показывать только активные (не удаленные) |
Опциональное |
filter | object |
Фильтрация |
Опциональное |
filter.<key> | map of object | Опциональное | |
from | int64 |
Возвращать начиная с элемента |
Опциональное |
ids[] | array of uuid |
Фильтрация по идентификаторам |
Опциональное |
size | int64 |
Количество возвращаемых элементов (максимум 10000) |
Опциональное |
sortExpressions[] | array |
Правила сортировки |
Опциональное |
sortExpressions[].ascending | boolean |
Признак сортировки по возрастанию |
Опциональное |
sortExpressions[].field | string |
Поле сортировки |
Опциональное |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации:
API key
Ответ
Могут быть возвращены следующие коды состояния HTTP:
HTTP-статус | Описание | Модель ответа |
---|---|---|
200 | OK Модель списка элементов контракта |
Модель списка элементов контракта (Получение списка элементов контракта) |