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

Creodock API

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

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

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

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
connectionIdОбязательно
pathstring · uuid
Идентификатор ресурса в пути запроса: connectionId.
directionIdОбязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.

Ответы

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

200

Connection

application/json

Схема: IntegrationConnectionDetail

ПолеТипОписание
activityОбязательно
object[]
Поле «activity» в структуре запроса или ответа.
bindingsОбязательно
object[]
Поле «bindings» в структуре запроса или ответа.
connectionОбязательно
IntegrationConnection
Поле «connection» в структуре запроса или ответа.
{
  "activity": [
    {}
  ],
  "bindings": [
    {}
  ],
  "connection": {
    "availableActions": [
      "string"
    ],
    "directionId": "00000000-0000-0000-0000-000000000000",
    "health": "healthy",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "ownerName": "string",
    "provider": "s3",
    "status": "active",
    "updatedAt": "2026-09-05T12:00:00Z",
    "version": 1
  }
}
403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

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

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

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

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