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

Creodock API

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

Получить: заказы

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

OpenAPI: Read one task by its workspace-scoped short order number

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
orderNumberОбязательно
pathinteger · int64
Идентификатор ресурса в пути запроса: orderNumber.Минимум: 1

Ответы

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

200

Grouped task detail

application/json

Схема: QueueTask

ПолеТипОписание
assigneesОбязательно
Option[]
Поле «assignees» в структуре запроса или ответа.
availableActionsОбязательно
TaskAction[]
Поле «availableActions» в структуре запроса или ответа.
briefMarkdownОбязательно
string
Поле «briefMarkdown» в структуре запроса или ответа.
clientОбязательно
Option
Поле «client» в структуре запроса или ответа.
creativesОбязательно
QueuePosition[]
Поле «creatives» в структуре запроса или ответа.
creativesCountОбязательно
integer
Поле «creativesCount» в структуре запроса или ответа.
deadlineAtОбязательно
string · date-time
Поле «deadlineAt» в структуре запроса или ответа.
formatsОбязательно
string[]
Поле «formats» в структуре запроса или ответа.
geosОбязательно
string[]
Поле «geos» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
inProgressSinceОбязательно
object
Поле «inProgressSince» в структуре запроса или ответа.
kindОбязательно
string
Поле «kind» в структуре запроса или ответа.Допустимо: standard, revisionПример: standard
linksНеобязательно
TaskLink[]
Поле «links» в структуре запроса или ответа.
numberОбязательно
integer · int64
Поле «number» в структуре запроса или ответа.
packagesНеобязательно
TaskPackage[]
Поле «packages» в структуре запроса или ответа.
pricingНеобязательно
TaskPricing
Поле «pricing» в структуре запроса или ответа.
priorityОбязательно
TaskPriority
Поле «priority» в структуре запроса или ответа.Допустимо: low, medium, highПример: low
referencesОбязательно
ResultAsset[]
Поле «references» в структуре запроса или ответа.
relatedOrdersОбязательно
RelatedTask[]
Поле «relatedOrders» в структуре запроса или ответа.
revisionsОбязательно
object[]
Поле «revisions» в структуре запроса или ответа.
sourceOrderНеобязательно
RelatedTask
Поле «sourceOrder» в структуре запроса или ответа.
statusОбязательно
TaskStatus
Текущий статус объекта.Допустимо: awaiting_payment, unassigned, assigned, in_progress, paused, submitted, revision, completed, cancelledПример: awaiting_payment
titleОбязательно
string
Название объекта, видимое пользователям.
updatedAtОбязательно
string · date-time
Дата и время последнего изменения в ISO 8601.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
verticalНеобязательно
Option
Поле «vertical» в структуре запроса или ответа.
workTypeОбязательно
Option
Поле «workType» в структуре запроса или ответа.
{
  "assignees": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "availableActions": [
    "assign"
  ],
  "briefMarkdown": "string",
  "client": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "creatives": [
    {
      "assets": [
        {}
      ],
      "assignee": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "availableActions": [
        "start"
      ],
      "format": "string",
      "geoCode": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "inProgressSince": "2026-09-05T12:00:00Z",
      "languageCode": "string",
      "status": "draft",
      "version": 1,
      "workedSeconds": 0
    }
  ],
  "creativesCount": 1,
  "deadlineAt": "2026-09-05T12:00:00Z",
  "formats": [
    "string"
  ],
  "geos": [
    "string"
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "inProgressSince": "2026-09-05T12:00:00Z",
  "kind": "standard",
  "links": [
    {
      "kind": "telegram",
      "label": "string",
      "url": "https://example.com/resource"
    }
  ],
  "number": 1,
  "packages": [
    {
      "briefMode": "shared",
      "creatives": [
        {}
      ],
      "defaultAssignee": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "links": [],
      "manualUnitAmountMinor": "string",
      "ordinal": 1,
      "pricingMode": "price_list",
      "sharedBriefMarkdown": "string",
      "sourceCreativeId": "00000000-0000-0000-0000-000000000000",
      "sourceKind": "creative",
      "sourceUrl": "https://example.com/resource",
      "title": "string",
      "workType": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "pricing": {
    "amountMinor": "string",
    "currency": "string",
    "scale": 0,
    "source": "price_list"
  },
  "priority": "low",
  "references": [
    {
      "byteSize": 1,
      "createdAt": "2026-09-05T12:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "result",
      "mimeType": "string",
      "originalFilename": "string",
      "taskCreativeId": "00000000-0000-0000-0000-000000000000",
      "taskGroupId": "00000000-0000-0000-0000-000000000000",
      "versionNumber": 1
    }
  ],
  "relatedOrders": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "standard",
      "number": 1,
      "title": "string"
    }
  ],
  "revisions": [
    {
      "affectedCreativeIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "authorName": "string",
      "closedAt": "2026-09-05T12:00:00Z",
      "createdAt": "2026-09-05T12:00:00Z",
      "groupId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "message": "string",
      "number": 1,
      "status": "open",
      "submittedAt": "2026-09-05T12:00:00Z"
    }
  ],
  "sourceOrder": {
    "id": "00000000-0000-0000-0000-000000000000",
    "kind": "standard",
    "number": 1,
    "title": "string"
  },
  "status": "awaiting_payment",
  "title": "string",
  "updatedAt": "2026-09-05T12:00:00Z",
  "version": 1,
  "vertical": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "workType": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  }
}
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": "Выберите формат." }
  ]
}