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

Creodock API

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

Создать: публичные трекеры

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

OpenAPI: Publish a tracker for orders belonging to one client

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

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

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

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

Параметры

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

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

Тело запроса

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

application/json
ПолеТипОписание
clientIdОбязательно
string · uuid
ID связанного клиента.
orderIdsОбязательно
string[]
Поле «orderIds» в структуре запроса или ответа.Минимум элементов: 1
titleОбязательно
string
Название объекта, видимое пользователям.Минимальная длина: 1 · Максимальная длина: 160

Ответы

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

201

Published tracker and public URL

403

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

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

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

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