Sign in
Cases

Get document status

Get a document's upload, extraction and analysis status, including the analysis result once complete

get/v1/cases/{caseId}/documents/{documentId}

Request

  • Base URL: https://dev.api.bb.tricirc.de (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api.bb.tricirc.de/v1/cases/{caseId}/documents/{documentId}
  • Auth: session-cookie (a scheme the document does not define)

Path parameters

caseIdstring required
documentIdstring required

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

documentIdstring required
extractionStatusstring required
fileNamestring required
uploadStatusstring required

Example response

{
  "$schema": "https://example.com/schemas/GetDocumentStatusOutputBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.