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

Creodock API

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

Получить: каталог рабочей области

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

OpenAPI: Get tenant-scoped values used to create an order

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

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

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

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

Параметры

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

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

Ответы

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

200

Order creation catalog

application/json

Схема: TaskCatalog

ПолеТипОписание
assigneesОбязательно
Option[]
Поле «assignees» в структуре запроса или ответа.
clientsОбязательно
CatalogClient[]
Поле «clients» в структуре запроса или ответа.
directionsОбязательно
Option[]
Поле «directions» в структуре запроса или ответа.
formatsОбязательно
CatalogFormat[]
Поле «formats» в структуре запроса или ответа.
geosОбязательно
CatalogGeo[]
Поле «geos» в структуре запроса или ответа.Минимум элементов: 249
languagesОбязательно
CatalogLanguage[]
Поле «languages» в структуре запроса или ответа.
pricesОбязательно
CatalogPrice[]
Поле «prices» в структуре запроса или ответа.
revisionSourcesОбязательно
RevisionSourceOrder[]
Поле «revisionSources» в структуре запроса или ответа.
verticalsОбязательно
Option[]
Поле «verticals» в структуре запроса или ответа.
workTypesОбязательно
WorkTypeCapability[]
Поле «workTypes» в структуре запроса или ответа.
{
  "assignees": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "clients": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "directions": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "formats": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "geos": [
    {
      "code": "string",
      "name": "string",
      "primaryLanguageCodes": [
        "string"
      ]
    }
  ],
  "languages": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "prices": [
    {
      "amountMinor": "string",
      "clientId": "00000000-0000-0000-0000-000000000000",
      "currency": "string",
      "formatId": "00000000-0000-0000-0000-000000000000",
      "scale": 0,
      "workTypeId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "revisionSources": [
    {
      "clientId": "00000000-0000-0000-0000-000000000000",
      "clientName": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "string",
      "number": 1,
      "title": "string",
      "verticalId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "verticals": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "workTypes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ]
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

500

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
500Внутренняя ошибкаДаПовторите безопасный запрос и сохраните traceId.

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