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

Creodock API

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

Получить: рабочая область

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

OpenAPI: Resolve the current tenant, role, directions and storage usage

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

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

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

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

Параметры

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

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

Ответы

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

200

Role-safe workspace context

application/json

Схема: WorkspaceContext

ПолеТипОписание
activeDirectionIdНеобязательно
string · uuid
Поле «activeDirectionId» в структуре запроса или ответа.
capabilitiesОбязательно
string[]
Поле «capabilities» в структуре запроса или ответа.
directionsОбязательно
Option[]
Поле «directions» в структуре запроса или ответа.
membershipIdОбязательно
string · uuid
Поле «membershipId» в структуре запроса или ответа.
organizationОбязательно
Option
Поле «organization» в структуре запроса или ответа.
organizationsОбязательно
Option[]
Поле «organizations» в структуре запроса или ответа.
roleОбязательно
string
Поле «role» в структуре запроса или ответа.Допустимо: owner, admin, manager, designerПример: owner
storageОбязательно
object
Поле «storage» в структуре запроса или ответа.
userОбязательно
object
Поле «user» в структуре запроса или ответа.
{
  "activeDirectionId": "00000000-0000-0000-0000-000000000000",
  "capabilities": [
    "string"
  ],
  "directions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "membershipId": "00000000-0000-0000-0000-000000000000",
  "organization": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "organizations": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "role": "owner",
  "storage": {
    "limitBytes": 1,
    "usedBytes": 1
  },
  "user": {
    "email": "developer@example.com",
    "name": "string",
    "planName": "string"
  }
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
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": "Выберите формат." }
  ]
}