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

Creodock API

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

Создать: загрузку референса

Создаёт загрузку референса на основании переданного тела запроса.

OpenAPI: Reserve a multipart upload for a task reference

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

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

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

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Параметры

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

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

Тело запроса

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

application/json

Схема: ReferenceUploadRequest

ПолеТипОписание
byteSizeОбязательно
integer
Поле «byteSize» в структуре запроса или ответа.Минимум: 1 · Максимум: 52428800
filenameОбязательно
string
Поле «filename» в структуре запроса или ответа.Минимальная длина: 1 · Максимальная длина: 512
mimeTypeОбязательно
string
Поле «mimeType» в структуре запроса или ответа.Допустимо: image/jpeg, image/png, image/webp, image/avif, image/gifПример: image/jpeg
taskCreativeIdНеобязательно
string · uuid
Поле «taskCreativeId» в структуре запроса или ответа.
taskGroupIdНеобязательно
string · uuid
Поле «taskGroupId» в структуре запроса или ответа.

Ответы

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

201

Upload reserved

application/json

Схема: ReferenceUploadReservation

ПолеТипОписание
expiresAtОбязательно
string · date-time
Поле «expiresAt» в структуре запроса или ответа.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
multipartUploadIdОбязательно
string
Поле «multipartUploadId» в структуре запроса или ответа.
partSizeОбязательно
integer
Поле «partSize» в структуре запроса или ответа.Минимум: 1
partUrlsОбязательно
object[]
Поле «partUrls» в структуре запроса или ответа.
{
  "expiresAt": "2026-09-05T12:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "multipartUploadId": "string",
  "partSize": 1,
  "partUrls": [
    {
      "partNumber": 1,
      "url": "https://example.com/resource"
    }
  ]
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

503

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.
503Сервис временно недоступенДаПовторите с экспоненциальной задержкой.

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