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

Creodock API

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

Отменить: загрузку референса

Отменяет, отзывает или удаляет загрузку референса в соответствии с правилами предметной области.

OpenAPI: Cancel an incomplete task reference upload

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

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

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

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

Параметры

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

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

Ответы

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

204

Upload cancelled

404

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
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": "Выберите формат." }
  ]
}