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

Creodock API

Все операции
POSTИнтеграция рабочей областиИдемпотентная команда

Получить: ставки исполнителей

Requires finance.operations and finance.read. Validates tenant, assigned recipient, state, position version and effective rate version. Cannot rewrite a priced or accrued unit. Accepted work receives exactly one missing accrual at its original acceptance timestamp. A reason is mandatory; idempotent replay returns the original response.

OpenAPI: Explicit audited price resolution of one unpriced production unit

POSThttps://api.creodock.com/api/v1/organizations/{organizationId}/finance/rates/resolve
Кто вызывает
Интеграция рабочей области
Передайте API-ключ рабочей области в заголовке Authorization: Bearer cdk_live_…
Доступ
finance.write
Все перечисленные права должны быть доступны вызывающей стороне.

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

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

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

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

application/json
ПолеТипОписание
positionIdОбязательно
string · uuid
Поле «positionId» в структуре запроса или ответа.
positionVersionОбязательно
integer
Поле «positionVersion» в структуре запроса или ответа.Минимум: 1
rateIdОбязательно
string · uuid
Поле «rateId» в структуре запроса или ответа.
rateVersionОбязательно
integer
Поле «rateVersion» в структуре запроса или ответа.Минимум: 1
reasonОбязательно
string
Поле «reason» в структуре запроса или ответа.Минимальная длина: 3 · Максимальная длина: 300

Ответы

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

200

Price resolved

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

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

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

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