Skip to main content
GET
Get a knowledge case's pending revision
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/knowledge/cases/getRevision?entryId=<id> returns a case’s pending revision: an edit of a proven case that waits for review before it replaces the proven text. It needs knowledge:read. data.state is one of: A malformed, missing, deleted, unreadable or source-restricted case answers 404 resource_missing.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

caseId
string
required

The case id (id from listKnowledgeCases).

Minimum string length: 1

Response

The case's pending revision state

data
object
required

A readable case's pending revision: none; restricted (a revision exists, but its source does not admit the caller, so nothing of it is returned); or pending, with the revision and its text, the success streak its scope needs to earn proven, and the pending review items that concern it (on the revision, or on the live case).

meta
object
required