Resolve Document Overview

Request

POST /api/reports/clients/{clientId}/instances/{instanceId}/documents

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.

Request Body

FormatKey describing the document to be requested.

Response

HTTP Status Code	Description
202 Accepted	Document instance created and rendering is initiated.
201 Created	Document instance already available.
410 Gone	The specified clientId cannot be found (expired).
404 Not Found	The specified instanceId cannot be found.

Response Body

When the return status is Accepted/Created the body contains a document identifier string which is used to get pages/document.

Sample

• Request

  POST /api/reports/clients/2c3d/instances/4d3c/documents HTTP/1.1
  
  {
      "format": "HTML5",
      "deviceInfo": { "xxx": "zzz" },
      "useCache": true,
      "baseDocumentId": "xxxx",
      "actionId": "xxxx"
  }
  

• Response

  HTTP/1.1 202 Accepted
  
  “5x3a”