Reports

Submit Render

POST /reports/render

Request body: RenderRequest

Responses

Status	Meaning	Body
202	Successful Response	RenderJobStatus
409	The stored template has no blocks to render.	ErrorEnvelope

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Download

GET /reports/renders/{render_id}

Parameters

Name	In	Type	Required	Description
render_id	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
200	Successful Response

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

List Templates

GET /reports/templates

Responses

Status	Meaning	Body
200	Successful Response	ReportTemplateCollection

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Get Template

GET /reports/templates/{template_id}

Parameters

Name	In	Type	Required	Description
template_id	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
200	Successful Response	ReportTemplateDocument

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Put Template

PUT /reports/templates/{template_id}

Parameters

Name	In	Type	Required	Description
template_id	path	string	yes	Letters, digits, dash and underscore; up to 64.

Request body: ReportTemplateDocument

Responses

Status	Meaning	Body
200	Successful Response	ReportTemplateDocument

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.

Delete Template

DELETE /reports/templates/{template_id}

Parameters

Name	In	Type	Required	Description
template_id	path	string	yes	Letters, digits, dash and underscore; up to 64.

Responses

Status	Meaning	Body
204	Successful Response

Also the shared errors: 400, 401, 404, 405, 422, 500, 501, 503.