[]
v8.0
(Showing Draft Content)

Reporting-Reports

Reporting-Reports

[POST] /api/v2/reporting/reports/{reportId}/export/{exportSettingsTemplateId}

Exports the report using export template.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e
exportSettingsTemplateIdRequired string path Export template id. For example: eb6d614f-e595-4de6-8c51-c54c6b07c295

Request Schema

ReportExportRequest

Response

Status Code: 200

Success

ReportExportResponse

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

[POST] /api/v2/reporting/reports/{reportId}/render-info

Renders report info.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

Request Schema

ReportRenderInfoRequest

Response

Status Code: 200

Success

ReportRenderInfoResponse

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

[POST] /api/v2/reporting/reports/{reportId}/render-parameters-values

Renders report parameters values.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

Request Schema

ReportRenderParametersValuesRequest

Response

Status Code: 200

Success

ReportRenderParametersValuesResponse

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

[GET] /api/v2/reporting/reports/{reportId}/download

Downloads the report.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

Response

Status Code: 200

Success

binary

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

[GET] /api/v2/reporting/reports/{reportId}/embedded/download

Downloads the report with embedded data.

Parameters

Name Type Located In Description
reportIdRequired string path Report id. For example: 3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

Response

Status Code: 200

Success

binary

Status Code: 400

Bad Request

ReportingPluginError

Status Code: 403

Forbidden

ReportingPluginError

Status Code: 404

Not Found

ReportingPluginError

Models

Ƭ ReportExportResponse

Report export response model.

Name Type Description Example
resultUrlNullable string Result URL.
resultIdNullable string Result id.
verificationUrlNullable string Verification URL.
renderingSkipped Boolean Whether the rendering was skipped.

Ƭ ReportingPluginError

Reporting plugin error

Name Type Description Example
codeNullable string error code
messageNullable string error message
contextNullable string error context

Ƭ ReportExportRequest

Report export request model.

Name Type Description Example
notificationSettingsNullable NotificationSettings Notification settings.
settingsNullable string Settings for rendering extensions. {"Title":"Overriden title"}
overrideExportTemplateSettings Boolean Whether to override export template settings. The default value is false.
interactiveActionsNullable Array<string> Interactive actions. ["rpt1/TextBox10/4/toggle","rpt1/TextBox10/5/toggle"]
skipEmptyReport Boolean Skip rendering of empty reports. The default value is false.
maxExecLimit int32 Internal. Max execution time.
parametersNullable Array Specified parameter values. {"StringParameter":["StringValue"],"Integer":[1],"Boolean":[false],"Date":["2000-01-01T00:00:00.000"]}
cacheRefreshIsRequired Boolean Refresh cached report. The default value is false.
allowedClaimsNullable string List of allowed claims. "full_name,phone_number"
userFunctionsNullable any List of User functions. {"CSharp":"","VisualBasic":""}

Ƭ NotificationSettings

Notification settings model.

Name Type Description Example
channel NotificationChannel
onSuccessNullable Array<string> List of contact names for notification of a successful operation.
onFailureNullable Array<string> List of contact names for notification of an unsuccessful operation.

Ƭ NotificationChannel

Enum:

  • API

Ƭ ReportRenderInfoResponse

Report render info response model.

Name Type Description Example
isFPL Boolean Whether a Fixed Page Layout is used in the report.
isSemantic Boolean Whether the report is semantic.
parametersNullable ParameterPayload Report parameters list.
displayTypeNullable string Report display type.
sizeTypeNullable string Report size type.
nameNullable string Report name.
parametersViewNullable string Parameters view.
initialIdNullable string Initial id.
referencesNullable DocumentReference Report references.
topParameterPanelHeightNullable int32 Top parameter panel height.
metaNullable string Report meta information.

Ƭ 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
displayFormatNullable string
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

Report render info request model.

Name Type Description Example
skipParameterValues Boolean Whether to skip processing parameter values. Default value is true. true

Ƭ ReportRenderParametersValuesRequest

Report render parameter values request model.

Name Type Description Example
valuesNullable Array Specified parameter values. {"BooleanParameter":[false],"StringMultiValueParameter":["value1","value2"]}
request QueryFields Names of the parameters we need to retrieve the values, validValues for. {"Parameter1":null}
allowedClaimsNullable string List of allowed claims. "full_name,phone_number"