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

Creodock API

Все операции
GETИнтерфейс Creodock

Получить видимость вкладок по ролям

Возвращает навигацию по ролям. Запрос предназначен для чтения и не изменяет данные.

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

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

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

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.

Ответы

Все состояния ответа, объявленные этой операцией в 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

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

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

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

Формат 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": "Выберите формат." }
  ]
}