Документация · v1

Creodock API

Все операции
PATCHИнтерфейс CreodockИдемпотентная команда

Изменить видимость вкладок для роли

Telegram Bot принудительно остаётся доступным. Менеджер с правом team.manage может менять только меню дизайнера.

PATCHhttps://api.creodock.com/api/v1/organizations/{organizationId}/settings/navigation
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: WorkspaceRoleNavigationUpdate

ПолеТипОписание
itemsОбязательно
string[]
Поле «items» в структуре запроса или ответа.
roleОбязательно
string
Поле «role» в структуре запроса или ответа.Допустимо: manager, designerПример: manager
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.Минимум: 0

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Обновлённая видимость вкладок

application/json

Схема: WorkspaceRoleNavigation

ПолеТипОписание
designerОбязательно
WorkspaceRoleNavigationEntry
Поле «designer» в структуре запроса или ответа.
managerОбязательно
WorkspaceRoleNavigationEntry
Поле «manager» в структуре запроса или ответа.
{
  "designer": {
    "items": [
      "overview"
    ],
    "version": 0
  },
  "manager": {
    "items": [
      "overview"
    ],
    "version": 0
  }
}
403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}