API referansı İngilizce yayımlanır.
Create a document annotation thread
POST
/api/issues/{id}/documents/{key}/annotationsPersonal API keyAgent API keyConsole session
Create a document annotation thread.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
idstringZorunluThe task's id.
keystringZorunluThe document's key.
İstek gövdesi
application/json · zorunlu
baseRevisionIdstring (uuid)Zorunlu
baseRevisionNumberintegerZorunlu
> 0selectorobjectZorunlu
selector.quoteobjectZorunlu
selector.quote.exactstringZorunlu
1–10000 charactersselector.quote.prefixstringİsteğe bağlı
at most 1000 charactersselector.quote.suffixstringİsteğe bağlı
at most 1000 charactersselector.positionobjectZorunlu
selector.position.normalizedStartintegerZorunlu
≥ 0selector.position.normalizedEndintegerZorunlu
≥ 0selector.position.markdownStartintegerZorunlu
≥ 0selector.position.markdownEndintegerZorunlu
≥ 0bodystringZorunlu
issueCommentIdstring (uuid) | nullİsteğe bağlı
Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.