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

Creodock API

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

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

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

OpenAPI: Preview the next workspace-scoped order number without reserving it

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

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

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

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

Параметры

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

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

Ответы

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

200

Non-reserved order number candidate

application/json

Схема: OrderNumberPreview

ПолеТипОписание
candidateОбязательно
integer · int64
Поле «candidate» в структуре запроса или ответа.Минимум: 1
reservedОбязательно
boolean
Поле «reserved» в структуре запроса или ответа.
{
  "candidate": 1,
  "reserved": true
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

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