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

Добавление правила доступа

Добавляет новое правило доступа

POST /cwm/public/api/v1/workspaces/{workspace}/workitems/{workitem}/sharing

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

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

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

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

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

Тело запроса

{
  "type": "User",
  "accessLevel": "Read",
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "type": "Group",
  "accessLevel": "Read",
  "groupId": "5fa85f64-5717-4512-b9fc-2c933f66afa5"
}

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

type

Тип доступа: пользователь или группа
"type": "Group" / "type": "User"

accessLevel

Уровень доступа
"accessLevel": "Read"

Возможные значения:

Read — только просмотр;
Edit — редактирование;
Comment — комментирование.

userID

Идентификатор пользователя
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"

groupID

Идентификатор группы
"groupId": "5fa85f64-5717-4512-b9fc-2c933f66afa5"

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

{
  "type": "User",
  "permissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workitemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accessLevel": "Read"
}

{
    "type": "User",
    "permissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "workitemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accessLevel": "Read",
    "user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "username": "string",
      "email": "string",
      "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
"type": "Group",
"permissionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"workitemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"accessLevel": "Read",
"group": {
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string"
}

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

type

Тип доступа: пользователь или группа
"type": "Group" / "type": "User"

permissionID

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

workspaceId

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

workitemId

Идентификатор задачи

accessLevel

Уровень доступа
"accessLevel": "Read"

Возможные значения:

Read — только просмотр;
Edit — редактирование;
Comment — комментирование.

Возвращаемые модели для пользователя и группы

user

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

group

Группа. Описание возвращаемой модели группы см. в разделе Группы

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

404 (Not Found)

Несуществующее расположение

500 (Server Error)

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