Creates, reads, updates, and deletes reports and report states

visualization_and_reports

2023.03

2023.10

2022.09

2024.07

2024.10

2024.09

2024.08

2024.03

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.


Reports

Returns the headers for a collection of report states of the current user associated with a report with standard paging, filtering, and sorting options.

Optional header.  If present, the locale it represents is used in processing, sorting, and filtering.

Accept-Language

reportId

0-based offset of the first item to return.

start

limit

The criteria for filtering the items. Report state attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See [Filtering in REST APIs](https://developer.sas.com/apis/rest/Topics/#filters).

filter

The criteria for sorting the items. Report attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See [Sorting in REST APIs](https://developer.sas.com/apis/rest/Topics/#sorting).

sortBy

Check the report states in standard report state format.

Error

application/vnd.sas.error

Check a collection of report states

The list of links to top-level resources and operations available from the root of the API.

Report Collection

The representation of a report. This representation is version 1.  Optional `version=1` parameter is the only `version` parameter that can be included.

Report

The representation of a report. This representation is version 1.  Optional `version=1` parameter is the only one that can be included.

New Report

The summarized representation of a resource. Often used in collection responses when more specific details aren't needed.

Resource Summary

Update Report

The representation of a report content in JSON format. Check [`Get Versions`](#/ReportContent/getReportContentVersions) and [`GET /versions/@defaultVersion`](#/ReportContent/getDefaultReportContentVersion) for the set of valid media types and versions as defined by `Business Intelligence Report Definition`.  If not provided, for request the version equivalent to the report content schema is used and for response latest version is used.

Report Content JSON

The representation of a report content in XML format. Check [`Get Versions`](#/ReportContent/getReportContentVersions) and [`GET /versions/@defaultVersion`](#/ReportContent/getDefaultReportContentVersion) for the set of valid media types and versions as defined by `Business Intelligence Report Definition`. If not provided, for request the version equivalent to the report content schema is used and for response latest version is used. The schema of this XML example is just for the example and therefore is only a very small subset of `Business Intelligence Report Definition`

Report Content XML

Report Version Collection

Report Version

The representation of a report content validation.

Report Content Validation

Report Content Elements Collection

The representation of a report state.  This is version 1 of the representation.

Report State

Report State Collection

The representation of a new report state.

New Report State

The representation of an updated report state.

Update Report State

The representation of a report state content, which has the same schema as report content, in JSON format. Check [`Get Versions`](#/ReportContent/getReportContentVersions) and [`GET /versions/@defaultVersion`](#/ReportContent/getDefaultReportContentVersion) for the set of valid media types and versions as defined by `Business Intelligence Report Definition`.  If not provided, for request the version equivalent to the report content schema is used and for response latest version is used.  The lowest valid version is 3.

The representation of a report state content, which has the same schema as report content, in XML format. Check [`Get Versions`](#/ReportContent/getReportContentVersions) and [`GET /versions/@defaultVersion`](#/ReportContent/getDefaultReportContentVersion) for the set of valid media types and versions as defined by `Business Intelligence Report Definition`. If not provided, for request the version equivalent to the report content schema is used and for response latest version is used. The lowest valid version is 3. The schema of this XML example is just for the example and therefore is only a very small subset of `Business Intelligence Report Definition`

Report State Content XML

Content providers may use this media type and appropriate endpoint to provide dependency information to the transfer service.

Transfer Dependencies

The representation of a report content element version 2.

Report content element

The representation of a report content element.

A relationship describes how two resources are related. The relationship contains a *subject* resource, the related resource, and the relationship type.

Relationship

A link to a related operation or resource.

Link

Content providers implementing the Transfer Object Provider contract use this media type to store information about the content to be transfered.

Transfer Object

Indxable representation of SAS type owner's data that searchindex service uses for indexing.

Indexable representation

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

Content providers implementing the Transfer Object Provider contract use this media type to provide connection information for the content to be transfered.

Transfer Object Connector

The definition for attribute that needs to be used within indexable representation. Here attribute is name,value Pair

Name	Type	Required	Description
filter	string<filter-criteria>	false	The criteria for filtering the items. Report state attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See Filtering in REST APIs.
limit	integer	false	Maximum number of items to return. Default: 20
sortBy	string<sort-criteria>	false	The criteria for sorting the items. Report attributes that can be used are `id`, `label`, `primary`, `createdBy`, `creationTimeStamp`, `modifiedBy`, and `modifiedTimeStamp`. See Sorting in REST APIs.
start	integer	false	0-based offset of the first item to return. Default: 0

Status	Meaning	Description
200	OK	Check the report states in standard report state format.
400	Bad Request	Bad Request.		Schema

Check a collection of report states

Request Samples

Response Samples

Path Parameters

Query Parameters

Header Parameters

Responses