get

[POST] …/v1/Role/get

Возвращает информацию о ролях

Входные параметры

Название Тип данных Обязательность Описание параметра
ids array of int64 Обязательный Массив id ролей
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
search string Необязательный Строка поиска по полям name, description
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

Модель сортировки выходных параметров

Название Тип данных Описание параметра
column enum Значение для сортировки: Id ( Id роли), Name (Наименование роли), Description (Дополнительное описание), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "ids":[1,2],
    "sort_orders":
    [
        {
        "column":'Name',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

Выходные параметры

Название Тип данных Обязательность Описание параметра
Result array of role Обязательный Массив объектов Role

Пример ответа

{
   "ok": true,
   "result": [
       {
           "id": 1,
           "name": "Administrator",
           "description": null,
           "last_update": 1531243535
       },
       {
           "id": 2,
           "name": "Manager",
           "description": null,
           "last_update": 1531243535
       }
   ],
    "next_offset": 0,
  "total": 2
}