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

visualization_and_reports

2022.09

2023.03

2023.10

2024.03

2024.06

2024.07

2024.08

2024.09

This API creates and manipulates "transforms" of SAS reports that conform to the Business Intelligence Report Definition (BIRD)  specification. A transform is a wrapper for a BIRD report. When a transform is part of a request, it contains instructions and parameters to perform an editing action or structural modification to the report. When a transform is part of a response, it describes the action or modification that was performed or attempted. The response transform  contains either the BIRD report directly, or it has a reference to a persistent report. All GET operations have a corresponding HEAD that is identical in all respects, except that a response body is not returned.

Report Transforms

Viya_35

Returns a list of top-level links to the resources available in the service.

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

application/vnd.sas.api

Return top-level links in type application/vnd.sas.api.

Format will match the request Accept header.

Content-Type

Bad request. The response object will contain an error code and further information.

Error

application/vnd.sas.error

The request was invalid. An error in the request resulted in failure to perform the action. See the error codes table for further details.

Get list of top-level links

The tranform is the primary payload in this service, for both requests and responses. Depending on the operation, some fields are required. For example, if the report to transform is a saved report, the `inputReportUri` field is required. Otherwise, the input report is in the body of request (in the transform) and `reportContent` is required.

transform

A report content that is the equivalent of the application/vnd.sas.report.content media type.  The report content is defined by a non-public XML Schema. The structure shown here is an abbreviation showing only a few of the descriptive attributes of the object.

sasReport

A data source that is used in a data mapping operation in a report.

dataSource

A message for the user with an associated error or warning code.

codedMessage

Prior to version 2, this was not an object. Instead, it was serialized as lines of user-editable plain text. When serialized as text, the first line is the locale indicator, and the subsequent lines have the form `proprietary path identifiers = translatable text`.

translationWorksheet

A link to a related operation or resource.

Link

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

report

The response from a pre-flight validation request. For APIs which support validation, the client can run operations (typically on resources in the `/commons/validation`) with `application/vnd.sas.validation+json` as the requested response type (via the `Accept:` request header). The service will validate the request but not execute the request, and return this response to indicate if the request was valid at the time it was made.

Status	Meaning	Description
200	OK	Return top-level links in type application/vnd.sas.api.	Headers	Schema
400	Bad Request	The request was invalid. An error in the request resulted in failure to perform the action. See the error codes table for further details.	Headers	Schema

Get list of top-level links

Request Samples

Response Samples

Responses