API referansı İngilizce yayımlanır.

Set case document

PUT/api/cases/{id}/documents/{key}
Personal API keyAgent API keyConsole sessionDeneysel
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Set case document.

Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.

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.
keystringZorunluThe document's key.

İstek gövdesi

application/json · zorunlu

titlestringİsteğe bağlı1–200 characters
formatstringİsteğe bağlı1–80 characters
bodystringZorunluat most 200000 characters
changeSummarystring | nullİsteğe bağlıat most 1000 characters
baseRevisionIdstring (uuid) | nullİsteğe bağlı

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.

Cases (experimental)