Справочник API публикуется на английском языке.
Create a document annotation
POST
/api/cases/{id}/documents/{key}/annotationsPersonal API keyAgent API keyConsole sessionЭкспериментальный
Create a document annotation.
Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.
Warning
This endpoint is experimental. Its request and response may change without notice.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
idstringОбязательныйThe case's id.
keystringОбязательныйThe document's key.
Тело запроса
application/json · обязательно
baseRevisionIdstring (uuid)Обязательный
baseRevisionNumberintegerОбязательный
> 0selectorobjectОбязательный
selector.quoteobjectОбязательный
selector.quote.exactstringОбязательный
1–10000 charactersselector.quote.prefixstringНеобязательный
at most 1000 charactersselector.quote.suffixstringНеобязательный
at most 1000 charactersselector.positionobjectОбязательный
selector.position.normalizedStartintegerОбязательный
≥ 0selector.position.normalizedEndintegerОбязательный
≥ 0selector.position.markdownStartintegerОбязательный
≥ 0selector.position.markdownEndintegerОбязательный
≥ 0bodystringОбязательный
issueCommentIdstring (uuid) | nullНеобязательный
Ответы
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.