Метод getCategoryList

Получение списка категорий конфигураций.

POST /v1/categories/search

Параметры запроса

Имя Описание Обязательный Тип Пример

page

Общее количество страниц

Нет

integer

2

pageSize

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

Нет

integer

20

Ответы

Код Сообщение Тип данных / объект схемы (DTO) Пример

200

Список категорий

CategoriesListResponse

 
{
  "meta": {
    "totalRecords": 1,
    "pageSize": 20,
    "totalPages": 1,
    "currentPage": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "categories": [
    {
      "createdAt": "2023-08-27T09:37:40.000Z",
      "color": "00ff00",
      "name": "Офис",
      "description": "Категория программ для работы в сети Интернет",
      "iconCode": "ms_office_icon",
      "id": "office",
      "updatedAt": "2023-08-27T09:37:40.000Z"
    },
    {
      "createdAt": "2023-08-27T09:37:40.000Z",
      "color": "00ee00",
      "name": "Дизайн",
      "description": "Программы для дизайнерской разработки, создания макетов",
      "iconCode": "ms_design_icon",
      "id": "design",
      "updatedAt": "2023-08-27T09:37:40.000Z"
    }
  ]
}

400

Некорректные параметры запроса

BasicError

 
{
  "code": "validation_failed",
  "message": "getCategoriesList.page: must be greater than or equal to 1"
}

401

Ошибка аутентификации

500

Внутренняя ошибка

BasicError

 
{
  "code": "internal_error",
  "message": "Database is unavailable"
}