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

Creodock API

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

Создать заказ

Безопасно создаёт заказы на основании переданного тела запроса.

OpenAPI: Create and publish an order with production creatives

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

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

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

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

Параметры

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

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

Тело запроса

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

application/json

Схема: CreateTaskRequestV6 | CreateTaskRequestV5 | CreateTaskRequestV4 | CreateTaskRequestV3 | CreateTaskRequestV2 | CreateTaskRequest

ПолеТипОписание
clientIdОбязательно
string · uuid
ID связанного клиента.
deadlineAtОбязательно
string · date-time
Поле «deadlineAt» в структуре запроса или ответа.
kindОбязательно
string
Поле «kind» в структуре запроса или ответа.
priorityОбязательно
TaskPriority
Поле «priority» в структуре запроса или ответа.Допустимо: low, medium, highПример: low
revisionОбязательно
CreateTaskRevisionV6
Поле «revision» в структуре запроса или ответа.
schemaVersionОбязательно
integer
Поле «schemaVersion» в структуре запроса или ответа.
titleНеобязательно
string
Название объекта, видимое пользователям.Максимальная длина: 240
verticalIdОбязательно
string · uuid
Поле «verticalId» в структуре запроса или ответа.

Ответы

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

201

Task created

application/json

Схема: CreateTaskResponse

ПолеТипОписание
groupsНеобязательно
CreateTaskGroupMapping[]
Поле «groups» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
numberОбязательно
integer · int64
Поле «number» в структуре запроса или ответа.
packagesНеобязательно
CreateTaskGroupMapping[]
Поле «packages» в структуре запроса или ответа.
{
  "groups": [
    {
      "clientKey": "string",
      "creatives": [
        {}
      ],
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "number": 1,
  "packages": [
    {
      "clientKey": "string",
      "creatives": [
        {}
      ],
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}
400

Problem Details response

application/json

Схема: Problem

401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

500

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
400Формат запроса неверенНетИсправьте JSON, заголовки или параметры пути.
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.
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": "Выберите формат." }
  ]
}