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

Creodock API

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

Изменить: заказы

Изменяет заказы и возвращает результат операции.

OpenAPI: Edit a published standard order and its production composition

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

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

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

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

Параметры

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

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

Тело запроса

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

application/json

Схема: UpdateTaskRequestV7

ПолеТипОписание
clientIdОбязательно
string · uuid
ID связанного клиента.
deadlineAtОбязательно
string · date-time
Поле «deadlineAt» в структуре запроса или ответа.
noteMarkdownНеобязательно
string
Поле «noteMarkdown» в структуре запроса или ответа.Максимальная длина: 20000
packagesОбязательно
CreateTaskPackageV5[]
Поле «packages» в структуре запроса или ответа.Минимум элементов: 1 · Максимум элементов: 30
priorityОбязательно
TaskPriority
Поле «priority» в структуре запроса или ответа.Допустимо: low, medium, highПример: low
schemaVersionОбязательно
integer
Поле «schemaVersion» в структуре запроса или ответа.
titleНеобязательно
string
Название объекта, видимое пользователям.Максимальная длина: 240
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.Минимум: 1
verticalIdОбязательно
string · uuid
Поле «verticalId» в структуре запроса или ответа.

Ответы

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

200

Updated task and stable client-key mappings

application/json

Схема: UpdateTaskResponseV7

{
  "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

404

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

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