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

Creodock API

Все операции
POSTИнтерфейс CreodockИдемпотентная команда

Создать переиспользуемую запись справочника

Создаёт organization-scoped значение, доступное в следующих заказах.

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

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

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

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
kindОбязательно
pathstring
Идентификатор ресурса в пути запроса: kind.Допустимо: vertical, work_type, formatПример: vertical
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: WorkspaceCatalogItemInput

ПолеТипОписание
durationSecondsНеобязательно
integer
Поле «durationSeconds» в структуре запроса или ответа.Минимум: 1
heightНеобязательно
integer
Поле «height» в структуре запроса или ответа.Минимум: 1
nameОбязательно
string
Отображаемое название.Минимальная длина: 1 · Максимальная длина: 120
widthНеобязательно
integer
Поле «width» в структуре запроса или ответа.Минимум: 1

Ответы

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

201

Запись создана

application/json

Схема: WorkspaceCatalogItem

ПолеТипОписание
activeОбязательно
boolean
Поле «active» в структуре запроса или ответа.
durationSecondsНеобязательно
integer
Поле «durationSeconds» в структуре запроса или ответа.Минимум: 1
heightНеобязательно
integer
Поле «height» в структуре запроса или ответа.Минимум: 1
idОбязательно
string · uuid
Уникальный идентификатор объекта.
nameОбязательно
string
Отображаемое название.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
visibilityОбязательно
string
Поле «visibility» в структуре запроса или ответа.Допустимо: reusable, draft_order, order_onlyПример: reusable
widthНеобязательно
integer
Поле «width» в структуре запроса или ответа.Минимум: 1
{
  "active": true,
  "durationSeconds": 1,
  "height": 1,
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "version": 1,
  "visibility": "reusable",
  "width": 1
}
403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

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