Перейти к содержанию

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

Возвращает список ролей пространства, соответствующих параметрам запроса.

GET /cwm/public/api/v1/workspaces/{workspace}/workitems

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

workspace (обязательный)

Ключ или идентификатор пространства

/cwm/public/api/v1/workspaces/KEY/workitems
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/workitems

name

Наименование роли (поиск по вхождению подстроки)

?name={string:255}

isSystemRole

Признак выводить только системные или не системные

?isSystemRole=True

fromToken

Токен запрашиваемой страницы

?fromToken=f5ce1753

maxItemsCount

Максимальное кол-во ролей на странице (по умолчанию: 50)

?maxItemsCount=200

Возможно комбинирование нескольких параметров фильтрации.

Тело успешного ответа 200

{
  "fromToken": "string",
  "maxItemsCount": 0,
  "nextToken": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "author": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string"
      },
      "isSystem": true,
      "permissions": [
        "WorkspaceContentRead"
      ]
    }
  ]
}

Описание возвращаемой модели

items

Список ролей. Модель роли описана в разделе Описание возвращаемой модели роли

fromToken

Токен запрошенной страницы результатов

maxItemsCount

Запрошенное кол-во элементов на странице результатов

nextToken

Токен следующей страницы результатов