Reports

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.

Root

The list of Reports service links.

Get header information for the service

Internal-Use OnlyRetrieves header information for the service. It can also be used to verify that the service is available./

Get a collection of top-level links

Internal-Use OnlyReturns a collection of links to the top-level collections surfaced through this API./

Report

The operations for the report resource.

Get a collection of reports

Internal-Use OnlyReturns a collection of reports with standard paging, filtering, and sorting options./reports

Create report

Internal-Use OnlyCreates a new report and adds it to a folder as a child./reports

Check report status

Internal-Use OnlyReturns the headers for a report, including ETag. See Conditional Operations./reports/{reportId}

Get a report

Internal-Use OnlyReturns the specified report, including ETag header. See Conditional Operations./reports/{reportId}

Check report resource summary status

Internal-Use OnlyReturns the headers for a report resource summary, including modifiedTimeStamp./reports/{reportId}

Get resource summary report

Internal-Use OnlyReturns the specified report in resource summary format./reports/{reportId}

Delete a report

Internal-Use OnlyDeletes the specified report and its content. Remove the report from the parent folder./reports/{reportId}

Update a report

Internal-Use OnlyUpdates the specified report. Requires an If-Match or If-Unmodified-Since request header. See Conditional Operations./reports/{reportId}

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.

Check status of report content

Internal-Use OnlyReturns the headers for report content, including the ETag. See Conditional Operations./reports/{reportId}/content

Get report content

Internal-Use OnlyReturns the report content, including ETag. See Conditional Operations./reports/{reportId}/content

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

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

Check persisted report content version

Internal-Use OnlyReturns whether the persisted report content version exists/reports/{reportId}/content/version

Get persisted report content version

Internal-Use OnlyReturns the persisted report content version./reports/{reportId}/content/version

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 available versions of report content

Internal-Use OnlyReturn all available versions of report content./versions

Get the default version of report content

Internal-Use OnlyReturn the current default versions of report content./versions/@defaultVersion

Get the report content version for the given semantic version

Internal-Use OnlyReturn the report content version for the given semantic version./versions/{semanticVersion}

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 report content elements

Internal-Use OnlyReturns the collection of elements./reports/{reportId}/content/elements

Convert content from XML to JSON

Internal-Use OnlyReturns the converted report content./content

Convert content from JSON to XML

Internal-Use OnlyReturns the converted report content./content

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.

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 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

Create report state

Internal-Use OnlyCreates a new report state./reports/{reportId}/states

Check report state status

Internal-Use OnlyReturns the headers for a report state, including ETag. stateId can also be a special string '@currentUserState' which is the report state id of the current user./reports/{reportId}/states/{stateId}

Get report state

Internal-Use OnlyReturns the specified report state, including ETag header. See Conditional Operations. stateId can also be a special string '@currentUserState' which is the report state id of the current user./reports/{reportId}/states/{stateId}

Delete report state

Internal-Use OnlyDeletes the specified report state./reports/{reportId}/states/{stateId}

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.

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 report state content

Internal-Use OnlyReturns the report state content, including ETag. See Conditional Operations./reports/{reportId}/states/{stateId}/content

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

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