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

Изменение типа доступа к комментарию

Изменяет тип доступа к комментарию (видимость комментария)

PUT /cwm/public/api/v1/workspaces/{workspace}/workitems/{workitem}/comments/{commentId}/visibility

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

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

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

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

Ключ или идентификатор задачи
?workitem=TS-13
?workitem=f5ce1753-ced5-4992-beb9-7408c1a56cf8

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

Идентификатор комментария ?commentId=f5ce1753-ced5-4992-beb9-7408c1a56cf8

Тело запроса

{
  "visibilityType": "All",
  "accessList": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "User"
    }
  ]
}

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

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

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

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

Список доступа. Пользователи или группы пользователей
Идентификатор, тип (пользователь или группа: User, Group)
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
"type": "User"

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

{
  "visibilityType": "All",
  "accessList": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "type": "User",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    },
    {
      "type": "Group",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      }
    }
  ]
}

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

visibilityType

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

accessList

Список доступа. Пользователи или группы пользователей
Тип (пользователь или группа), идентификатор типа, данные о пользователе или группе

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

500 (Server Error)

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