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

Creodock API

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

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

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

OpenAPI: List direction-scoped integration connections and delivery attention

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdОбязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.
statusНеобязательно
queryIntegrationConnectionStatus
Параметр фильтрации или управления выдачей: status.Допустимо: active, paused, attention, disconnectedПример: active

Ответы

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

200

Integration connection page

application/json

Схема: IntegrationOverview

ПолеТипОписание
attentionОбязательно
object[]
Поле «attention» в структуре запроса или ответа.
catalogОбязательно
object[]
Поле «catalog» в структуре запроса или ответа.
connectionsОбязательно
IntegrationConnection[]
Поле «connections» в структуре запроса или ответа.
filtersОбязательно
object
Поле «filters» в структуре запроса или ответа.
{
  "attention": [
    {}
  ],
  "catalog": [
    {}
  ],
  "connections": [
    {
      "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
    }
  ],
  "filters": {}
}
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": "Выберите формат." }
  ]
}