v1

latestOpenAPI 3.0.12026-07-24285462499.1 KB
reports

Generate ad-hoc report

Use this endpoint to generate ad-hoc report. NOTE: Report files are generated asynchronously. Ensure the report file status is: COMPLETED before fetching the data. To check the report file status use the GET /reports/{reportId}/files/recent endpoint.

post/reports/{reportId}/files

Path parameters

reportIdstring required

Report identifier

Response

Successful response.

reportFileIdstring
reportIdstring
reportFileStatus'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED'
scheduleType'AD_HOC' | 'SCHEDULED'
schedulingDatestring date-time
generationDatestring date-time
requestorIdstring
accessGroupIdstring
systemRoleIdstring
rowEntityTypeIdstring
rowEntityInstanceIdstring
errorReason'UNKNOWN' | 'MISSING_ACCESS_GROUP' | 'ACCESS_GROUP_MISMATCH' | 'MISSING_SYSTEM_ROLE' | 'SYSTEM_ROLE_MISMATCH' | 'REPORTING_AREA_RESTRICTED' | 'INCORRECT_ACCESS_CONFIGURATION' | 'MISSING_REPORT_CREATOR_EMPLOYEE' | 'MAX_REPORT_FILE_SIZE_EXCEEDED'