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

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

Возвращает конкретную страницу.

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

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

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

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

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

Ключ или идентификатор страницы
/cwm/public/api/v1/workspaces/{workspace}/documents/f5ce1753-ced5-4992-beb9-7408c1a56cf8 /cwm/public/api/v1/workspaces/{workspace}/documents/TS-13

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

Нажмите, чтобы увидеть пример 
{
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "name": "string",
  "documentUrl": "string",
  "content": "string",
  "createdAt": "2025-02-23T17:26:25.245Z",
  "author": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "string",
    "username": "string",
    "email": "string",
    "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "updatedAt": "2025-02-23T17:26:25.245Z",
  "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
}

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

workspaceId

Идентификатор пространства

id

Идентификатор страницы

key

Ключ страницы

name

Название страницы

documentUrl

Адрес страницы

content

Содержимое страницы. Формат разметки описания приведен в разделе Форматирование текста

createdAt

Дата и время создания страницы

author

Пользователь, создавший страницу. Данные о пользователе соответствуют описанию возвращаемой модели пользователя

updatedAt

Дата и время внесения изменений на страницу

updatedBy

Пользователь, изменивший страницу. Данные о пользователе соответствуют описанию возвращаемой модели пользователя

parent

Родительский элемент для страницы. Идентификатор и тип элемента. Типы: Folder / Task / Workspace / Document

```json

    {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "nodeType": "Document"
    }
```

version

Версия страницы. Числовое значение версии

versionUrl

Адрес версии страницы

labels

Метки страницы

isBlocked

Признак блокировки страницы: True / False
True — страница заблокирована для изменений. False — страницу можно редактировать.

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

500 (Server Error)

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