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

Получение всех страниц

Возвращает все страницы пространства с пагинацией

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

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

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

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

fromToken

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

maxItemsCount

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

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

Нажмите, чтобы увидеть пример
    {
      "fromToken": "string",
      "maxItemsCount": 0,
      "nextToken": "string",
      "items": [
        {
          "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "key": "string",
          "name": "string",
          "documentUrl": "string",
          "content": "string",
          "createdAt": "2025-02-23T20:52:19.874Z",
          "author": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "displayName": "string",
            "username": "string",
            "email": "string",
            "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          },
          "updatedAt": "2025-02-23T20:52:19.874Z",
          "updatedBy": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "displayName": "string",
            "username": "string",
            "email": "string",
            "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          },
          "parent": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "nodeType": "Folder"
          },
          "version": 0,
          "versionUrl": "string",
          "labels": [
            "string"
          ],
          "isBlocked": true
        }
      ]
    }

Параметры и описание возвращаемой модели

fromToken

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

maxItemsCount

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

nextToken

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

items

Список страниц.
Модель страницы описана в подразделе Получение страницы

Ошибки

400 (Bad Request)

Неправильный (несуществующий) параметр запроса

401 (Unauthorized)

Неавторизованный запрос

403 (Forbidden)

Отказ доступа к объекту

500 (Server Error)

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