Reports

Start a workbook report generation. Use the returned URL to check the status of the report generation.

post/api/v1/Reports/Workbooks/{workbookId}/Generate

Request

Base URL
https://api.slopesoftware.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Reports/Workbooks/:workbookId/Generate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workbookIdstring required

Workbook ID

Request body

elementIdstring nullable

Workbook Element ID

reportFormat'Csv' | 'Excel' | 'Png'

rowLimitinteger nullable

Row Limit

offsetinteger nullable

Offset

parametersobject nullable

Parameters — the Workbook control values to apply, keyed by the control's name. At least one projection ID control has to be supplied; filtering the report down far enough to complete in time is the caller's responsibility.

Response

Success

Changes

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