La référence de l'API est publiée en anglais.
Create a document annotation thread
POST
/api/issues/{id}/documents/{key}/annotationsPersonal API keyAgent API keyConsole session
Create a document annotation thread.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
idstringObligatoireThe task's id.
keystringObligatoireThe document's key.
Corps de la requête
application/json · obligatoire
baseRevisionIdstring (uuid)Obligatoire
baseRevisionNumberintegerObligatoire
> 0selectorobjectObligatoire
selector.quoteobjectObligatoire
selector.quote.exactstringObligatoire
1–10000 charactersselector.quote.prefixstringFacultatif
at most 1000 charactersselector.quote.suffixstringFacultatif
at most 1000 charactersselector.positionobjectObligatoire
selector.position.normalizedStartintegerObligatoire
≥ 0selector.position.normalizedEndintegerObligatoire
≥ 0selector.position.markdownStartintegerObligatoire
≥ 0selector.position.markdownEndintegerObligatoire
≥ 0bodystringObligatoire
issueCommentIdstring (uuid) | nullFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.