[]
        
(Showing Draft Content)

Session

Session

[POST] /api/reporting/reports/{reportId}/render

Parameters

Name Type Located In
snapshotOnly Boolean query
reportIdRequired string path

Request Schema

RenderPayload

Response

Status Code: 200

Success

[DELETE] /api/reporting/job/{sessionId}

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

[GET] /api/reporting/job/{sessionId}

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

[GET] /api/reporting/job/{sessionId}/result

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

[GET] /api/reporting/job/{sessionId}/error

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

[POST] /api/reporting/session/{sessionId}/renderview

Parameters

Name Type Located In
sessionIdRequired string path

Request Schema

RenderSnapshotPayload

Response

Status Code: 200

Success

[POST] /api/reporting/session/{sessionId}/export/{extensionName}

Parameters

Name Type Located In
sessionIdRequired string path
extensionNameRequired string path

Request Schema

ExportSnapshotPayload

Response

Status Code: 200

Success

[POST] /api/reporting/view/{sessionId}/export/{extensionName}

Parameters

Name Type Located In
sessionIdRequired string path
extensionNameRequired string path

Request Schema

ExportSnapshotPayload

Response

Status Code: 200

Success

[POST] /api/reporting/session/{sessionId}/exportTemplate/{exportSettingTemplateId}/{overrideExportSettings}

Parameters

Name Type Located In
sessionIdRequired string path
exportSettingTemplateIdRequired string path
overrideExportSettings Boolean query

Request Schema

ExportSnapshotPayload

Response

Status Code: 200

Success

[POST] /api/reporting/session/{sessionId}/close

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

Models

Ƭ RenderPayload

Name Type Description Example
parametersNullable Array
cacheRefreshIsRequired Boolean
settingsNullable string
interactiveActionsNullable Array<string>
skipEmptyReport Boolean
maxExecLimit int32

Ƭ RenderSnapshotPayload

Name Type Description Example
resourceRootURINullable string
parametersNullable Array
cacheRefreshIsRequired Boolean
settingsNullable string
interactiveActionsNullable Array<string>
skipEmptyReport Boolean
maxExecLimit int32

Ƭ ExportSnapshotPayload

Name Type Description Example
sessionIdNullable string
resourceRootURINullable string
allowedClaimsNullable string
userFunctionsNullable any
exportFormatNullable string
parametersNullable Array
cacheRefreshIsRequired Boolean
settingsNullable string
interactiveActionsNullable Array<string>
skipEmptyReport Boolean
maxExecLimit int32