API referansı İngilizce yayımlanır.
Read a case and its current facts
GET
/api/cases/{id}Personal API keyAgent API keyConsole sessionDeneysel
Read a case and its current facts.
Returns the case identifier, title, status, current facts (fields) and primary task. 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.
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 case's id.
Sorgu parametreleri
includeDocumentBodiesstringİsteğe bağlı
one of: "0", "1", "true", "false"Yanıtlar
200SuccessThe request worked; the body holds the result.
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.