Reports

Loading...
You can use the Reports API to create, read, and update reports. This API enables basic tasks such as moving or renaming reports, as well as editorial tasks such as reading, writing, and updating report content.

Report

The operations for the report resource.
get
Get a collection of reports
Internal-Use OnlyReturns a collection of reports with standard paging, filtering, and sorting options.
/reports
post
Create report
Internal-Use OnlyCreates a new report and adds it to a folder as a child.
/reports
head
Check report status
Internal-Use OnlyReturns the headers for a report, including ETag. See Conditional Operations.
/reports/{reportId}
get
Get a report
Internal-Use OnlyReturns the specified report, including ETag header. See Conditional Operations.
/reports/{reportId}
head
Check report resource summary status
Internal-Use OnlyReturns the headers for a report resource summary, including modifiedTimeStamp.
/reports/{reportId}
get
Get resource summary report
Internal-Use OnlyReturns the specified report in resource summary format.
/reports/{reportId}
delete
Delete a report
Internal-Use OnlyDeletes the specified report and its content. Remove the report from the parent folder.
/reports/{reportId}
put
Update a report
Internal-Use OnlyUpdates the specified report. Requires an If-Match or If-Unmodified-Since request header. See Conditional Operations.
/reports/{reportId}
post
Validate report name
Internal-Use OnlyEnsures that the name does not exceed the maximum length and, if parentFolderUri is provided, that a report with the name can be added as a member without conflict. The validation does not check whether or not the user can actually add a report with the given name to the folder.
/validations/name

ReportContent

The operations for the report content resource.
head
Check status of report content
Internal-Use OnlyReturns the headers for report content, including the ETag. See Conditional Operations.
/reports/{reportId}/content
get
Get report content
Internal-Use OnlyReturns the report content, including ETag. See Conditional Operations.
/reports/{reportId}/content
put
Save report content
Internal-Use OnlySaves the report content. Does not return the stored content. An ETag is not required for the initial save, but is required for all subsequent saves. In some situations, where an Accept type header is automatically generated, setting it to '*/*' will achieve the same effect as omitting it. See Conditional Operations.
/reports/{reportId}/content
put
Save and return report content
Internal-Use OnlyAn ETag is not required for the initial save, but is required for all subsequent saves. See Conditional Operations. A different response code is returned depending on whether the request is for the initial save or a subsequent save.
/reports/{reportId}/content
head
Check persisted report content version
Internal-Use OnlyReturns whether the persisted report content version exists
/reports/{reportId}/content/version
get
Get persisted report content version
Internal-Use OnlyReturns the persisted report content version.
/reports/{reportId}/content/version
post
Validate the persisted report content schema
Internal-Use OnlyValidates the report content against a schema. The schema specified in the report content is used for validation.
/reports/{reportId}/content/validation
get
Get available versions of report content
Internal-Use OnlyReturn all available versions of report content.
/versions
get
Get the default version of report content
Internal-Use OnlyReturn the current default versions of report content.
/versions/@defaultVersion
get
Get the report content version for the given semantic version
Internal-Use OnlyReturn the report content version for the given semantic version.
/versions/{semanticVersion}
head
Check report content elements status
Internal-Use OnlyReturns the headers for a report content elements, including ETag. See Conditional Operations.
/reports/{reportId}/content/elements
get
Get report content elements
Internal-Use OnlyReturns the collection of elements.
/reports/{reportId}/content/elements
post
Convert content from XML to JSON
Internal-Use OnlyReturns the converted report content.
/content
post
Convert content from JSON to XML
Internal-Use OnlyReturns the converted report content.
/content
post
Validate report content schema
Internal-Use OnlyValidates the report content against a schema. The schema specified in the report content is used for validation.
/content/validation

ReportState

The operations for the report state resource.
head
Check a collection of report states
Internal-Use OnlyReturns the headers for a collection of report states of the current user associated with a report with standard paging, filtering, and sorting options.
/reports/{reportId}/states
get
Get a collection of report states
Internal-Use OnlyReturns a collection of report states of the current user associated with a report with standard paging, filtering, and sorting options.
/reports/{reportId}/states
post
Create report state
Internal-Use OnlyCreates a new report state.
/reports/{reportId}/states
head
Check report state status
Internal-Use OnlyReturns the headers for a report state, including ETag.
/reports/{reportId}/states/{stateId}
get
Get report state
Internal-Use OnlyReturns the specified report state, including ETag header. See Conditional Operations.
/reports/{reportId}/states/{stateId}
delete
Delete report state
Internal-Use OnlyDeletes the specified report state.
/reports/{reportId}/states/{stateId}
put
Update report state
Internal-Use OnlyUpdates the specified report state. Either an If-Match or If-Unmodified-Since request header is required. See Conditional Operations.
/reports/{reportId}/states/{stateId}

ReportStateContent

The operations for the report state content resource.
head
Check report state content status
Internal-Use OnlyReturns the headers for a report state content, including ETag. See Conditional Operations.
/reports/{reportId}/states/{stateId}/content
get
Get report state content
Internal-Use OnlyReturns the report state content, including ETag. See Conditional Operations.
/reports/{reportId}/states/{stateId}/content
put
Save report state content
Internal-Use OnlySaves the report state content. Does not return the stored state content. An ETag is not required for the initial save, but is required for all subsequent saves. In some situations where Accept type header is automatically generated, setting it to '*/*' will achieve the same effect as not including it. See Conditional Operations.
/reports/{reportId}/states/{stateId}/content
put
Store and return report state content
Internal-Use OnlySaves and returns the report state content. An ETag is not required for the initial save, but required for all subsequent saves. See Conditional Operations. A different response code is returned depending on whether the request is for the initial save or a subsequent save.
/reports/{reportId}/states/{stateId}/content