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

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

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

PUT /cwm/public/api/v1/workspaces/{workspace}/queries/{queryId}/visibility

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

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

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

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

Идентификатор запроса ?queryId=f5ce1758-ced5-4892-beb9-7408c1a56cf8

Тело запроса

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

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

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

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

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

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

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

{
  "visibilityType": "Author",
  "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

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

accessList

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

Ошибки

400 (Bad Request)

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

401 (Unauthorized)

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

403 (Forbidden)

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

500 (Server Error)

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