La referencia de la API se publica en inglés.
Create a document annotation
POST
/api/cases/{id}/documents/{key}/annotationsPersonal API keyAgent API keyConsole sessionExperimental
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.
Autorización
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. Cómo funcionan las claves.
Parámetros de ruta
idstringObligatorioThe case's id.
keystringObligatorioThe document's key.
Cuerpo de la solicitud
application/json · obligatorio
baseRevisionIdstring (uuid)Obligatorio
baseRevisionNumberintegerObligatorio
> 0selectorobjectObligatorio
selector.quoteobjectObligatorio
selector.quote.exactstringObligatorio
1–10000 charactersselector.quote.prefixstringOpcional
at most 1000 charactersselector.quote.suffixstringOpcional
at most 1000 charactersselector.positionobjectObligatorio
selector.position.normalizedStartintegerObligatorio
≥ 0selector.position.normalizedEndintegerObligatorio
≥ 0selector.position.markdownStartintegerObligatorio
≥ 0selector.position.markdownEndintegerObligatorio
≥ 0bodystringObligatorio
issueCommentIdstring (uuid) | nullOpcional
Respuestas
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.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.