Reporting-Reports
Reporting-Reports
[POST] /api/v2/reporting/reports/{reportId}/export/{exportSettingsTemplateId}
Parameters
| Name | Type | Located In |
|---|---|---|
| reportIdRequired | string | path |
| exportSettingsTemplateIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[POST] /api/v2/reporting/reports/{reportId}/render-info
Parameters
| Name | Type | Located In |
|---|---|---|
| reportIdRequired | string | path |
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/reporting/reports/{reportId}/render-parameters-values
Parameters
| Name | Type | Located In |
|---|---|---|
| reportIdRequired | string | path |
Request Schema
ReportRenderParametersValuesRequest
Response
Status Code: 200
Success
ReportRenderParametersValuesResponse
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/reporting/reports/{reportId}/download
Parameters
| Name | Type | Located In |
|---|---|---|
| reportIdRequired | string | path |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/reporting/reports/{reportId}/embedded/download
Parameters
| Name | Type | Located In |
|---|---|---|
| reportIdRequired | string | path |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
Models
Ƭ ReportExportResponse
| Name | Type | Description | Example |
|---|---|---|---|
| resultUrlNullable | string | ||
| resultIdNullable | string | ||
| verificationUrlNullable | string | ||
| renderingSkipped | Boolean |
Ƭ ReportingPluginError
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | ||
| messageNullable | string | ||
| contextNullable | string |
Ƭ ReportExportRequest
| Name | Type | Description | Example |
|---|---|---|---|
| settingsNullable | string | ||
| overrideExportTemplateSettings | Boolean | ||
| interactiveActionsNullable | Array<string> |
||
| skipEmptyReport | Boolean | ||
| parametersNullable | Array |
||
| cacheRefreshIsRequired | Boolean | ||
| allowedClaimsNullable | string | ||
| userFunctionsNullable | any |
Ƭ ReportRenderInfoResponse
| Name | Type | Description | Example |
|---|---|---|---|
| isFPL | Boolean | ||
| isSemantic | Boolean | ||
| parametersNullable | ParameterPayload | ||
| displayTypeNullable | string | ||
| sizeTypeNullable | string | ||
| nameNullable | string | ||
| parametersViewNullable | string | ||
| initialIdNullable | string | ||
| referencesNullable | DocumentReference | ||
| topParameterPanelHeightNullable | int32 | ||
| metaNullable | string |
Ƭ ParameterPayload
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | ||
| promptNullable | string | ||
| dataTypeNullable | string | ||
| selectAllValueNullable | any | ||
| allowBlank | Boolean | ||
| nullable | Boolean | ||
| multiValue | Boolean | ||
| multiline | Boolean | ||
| hidden | Boolean | ||
| usedInQueryNullable | string | ||
| dependsOnNullable | Array<string> |
||
| dateOnly | Boolean | ||
| validValues | ParameterValidValueCollection | ||
| defaultValue | ParameterDefaultValueCollection |
Ƭ DocumentReference
| Name | Type | Description | Example |
|---|---|---|---|
| resourceNameNullable | string | ||
| resourceDocTypeNullable | string | ||
| documentIdNullable | string | ||
| documentRev | int32 | ||
| contentUrlNullable | string |
Ƭ ParameterValidValueCollection
| Name | Type | Description | Example |
|---|---|---|---|
| dataSet | ParameterValidValueDatasetReference | ||
| valuesNullable | ParameterValidValueDescriptor |
Ƭ ParameterDefaultValueCollection
| Name | Type | Description | Example |
|---|---|---|---|
| dataSet | ParameterValidValueDatasetReference | ||
| valuesNullable | Array |
Ƭ ParameterValidValueDatasetReference
| Name | Type | Description | Example |
|---|---|---|---|
| dataSetNameNullable | string | ||
| labelFieldNullable | string | ||
| valueFieldNullable | string |
Ƭ ParameterValidValueDescriptor
| Name | Type | Description | Example |
|---|---|---|---|
| labelNullable | string | ||
| valueNullable | any |
Ƭ ReportRenderInfoRequest
| Name | Type | Description | Example |
|---|---|---|---|
| skipParameterValues | Boolean |
Ƭ ReportRenderParametersValuesResponse
| Name | Type | Description | Example |
|---|---|---|---|
| validValuesNullable | ParameterValidValueDescriptorExtra | ||
| valuesNullable | Array |
Ƭ ParameterValidValueDescriptorExtra
| Name | Type | Description | Example |
|---|---|---|---|
| fieldsNullable | Array |
||
| labelNullable | string | ||
| valueNullable | any |
Ƭ ReportRenderParametersValuesRequest
| Name | Type | Description | Example |
|---|---|---|---|
| valuesNullable | Array |
||
| request | QueryFields | ||
| allowedClaimsNullable | string |