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

Получение папок пространства

Возвращает все папки пространства с фильтрацией и пагинацией.

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

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

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

Ключ или идентификатор пространства
/cwm/public/api/v1/workspaces/KEY/workitems
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/workitems

name

Название папки для фильтрации (вхождение подстроки)
?name=Папка 1

parentId

Идентификатор родительской папки
?parentId=f5ce1753-ced5-4992-beb9-7408c1a56cf8

fromToken

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

maxItemsCount

Максимальное кол-во задач на странице (по умолчанию: 50)
?maxItemsCount=200

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

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

{
  "fromToken": "string",
  "maxItemsCount": 0,
  "nextToken": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

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

fromToken >

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

maxItemsCount >

Кол-во запрошенных элементов на странице результатов

nextToken

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

items

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