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

Creodock API

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

Удалить внутреннюю заметку клиента

Удаляет заметку по optimistic version; audit history сохраняется.

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

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

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

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

Параметры

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

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

Ответы

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

200

Заметка удалена

application/json

Схема: MutationResult

ПолеТипОписание
idОбязательно
string · uuid
Уникальный идентификатор объекта.
versionНеобязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "id": "00000000-0000-0000-0000-000000000000",
  "version": 1
}
403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

409

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.

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