Get Document Info Overview

Request

GET /api/reports/clients/{clientId}/instances/{instanceId}/documents/{documentId}/info

Path parameters

Name	Type	Description
clientId	String	ID of the service client. Returned from Register Client.
instanceId	String	ID of the report instance. Returned from Resolve Report Instance.
documentId	String	ID of the report document. Returned from Resolve Document.

Response

HTTP Status Code	Description
202 Accepted	Document processing is still in progress.
200 OK	Document processing is ready.
410 Gone	The specified clientId cannot be found (expired).
404 Not Found	The specified instanceId or documentId cannot be found.

Response Body

DocumentInfo

Sample

• Request

  GET /api/reports/clients/2c3d/instances/4d3c/documents/5x3a/info HTTP/1.1
  

• Response

  HTTP/1.1 202 Accepted
  
  {
      "documentReady": false,
      "PageCount": 2,
      "DocumentMapAvailable": false,
  }