Skip to Content
veriom

Preview report document

The report laid out as its PDF, with the studio's composition, saved or not. Reading only: nothing is stored. The PDF, DOCX and Markdown exports render the same document, so the preview is what the exports will say.

POST
/v1/workspaces/{workspace_id}/reports/{report_id}/document

The report laid out as its PDF, with the studio's composition, saved or not.

Reading only: nothing is stored. The PDF, DOCX and Markdown exports render the same document, so the preview is what the exports will say.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
report_id*Report Id
Formatuuid

Request Body

application/json
  1. body
config?|

The studio's composition, saved or not; the saved one when omitted.

Response Body

Successful Response

application/json
  1. response

The report as its PDF lays it out, for the studio's live preview.

css*Css

The one stylesheet the PDF and the preview share.

html*Html

The document's markup; every value is escaped.

version*Version
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/document' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "css": "string",  "html": "string",  "version": "string"}