RestApiCategories.visualizationAndReports.desc

visualization_and_reports

2023.10

2023.03

2024.10

2024.03

2024.09

2024.08

2024.11

2024.12

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 report content elements, including `ETag`. See [`Conditional Operations`](https://developer.sas.com/rest-apis/reports-v7/docs/getting-started/usage-notes#conditional-operations).

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

Accept-Language

Optional header.  If omitted, items of `application/vnd.sas.report.content.element+json` type are returned.

Accept-Item

reportId

A '&#124;' (bar) separated list of characteristics of elements to return. A characteristic is a set of attributes of an element. An element has only one type but it can have many characteristics. If no characteristic is specified, then all elements are returned. Valid values are `visualElement`, `dataSource`, and `visualElementsBySection`

characteristics

A tag that identifies this revision of the resource.

ETag

This header represents the locale of the result. It may not be present if there is issue during localization, in which case the result is what is persisted.

Content-Language

The last `modifiedTimeStamp` of the resource.

Last-Modified

The report or report content does not exist.

Check report content elements status

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

Error

The representation of a report content element version 2.

Report content element

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

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

Relationship

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

The representation of a report content element.

A link to a related operation or resource.

Link

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

Property

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

Name	Type	Required	Description
Accept-Item	string	false	Optional header. If omitted, items of `application/vnd.sas.report.content.element+json` type are returned. Allowed values: application/vnd.sas.report.content.element+jsonapplication/vnd.sas.report.content.element+json;version=1application/vnd.sas.report.content.element+json;version=2 Default: application/vnd.sas.report.content.element+json;version=2
Accept-Language	string	false	Optional header. If present, the locale it represents is used in processing, sorting, and filtering.

Status	Meaning	Description
200	OK	Check status operation was successful.	Headers
404	Not Found	The report or report content does not exist.

Check report content elements status

Request Samples

Response Samples

Path Parameters

Query Parameters

Header Parameters

Responses