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

Возвращает список комментариев страницы

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

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

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

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

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

Ключ или идентификатор страницы
TS-13
f5ce1753-ced5-4992-beb9-7408c1a56cf8

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

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "text": "string",
      "author": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "createdAt": "2025-03-02T12:28:15.950Z",
      "updatedAt": "2025-03-02T12:28:15.950Z",
      "visibilityType": "All"
    }
  ]
}

items

Список комментариев страницы.</br

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

id

Идентификатор комментария

text

Текст комментария

author

Пользователь, оставивший комментарий. Соответствует возвращаемой модели пользователя.

createdAt

Время создания комментария

updatedAt

Время изменения комментария

visibilityType

Тип доступа к комментарию:
All (доступен всем)
Workspace (доступен пользователям пространства)
OnlySelected (доступен только выбранным пользователям)
ExceptSelected (доступен всем, кроме выбранных пользователей)

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

500 (Server Error)

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