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

visualization_and_reports

2022.09

2023.10

2023.03

2024.09

2024.10

2024.08

2024.03

2024.07

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

Extract the translator's localization worksheet from a report for the specified locale. The human translator can use the worksheet to translate individual strings, and the worksheet can later be saved back to the report.

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.

The BIRD report from which to extract the translatable strings.

The locale for which the translation should be extracted.

translationLocale

Determine whether to validate the report content against an XML schema. Defaults to true. Schema validation errors do not necessarily halt processing. Errors are reported in the transform's errorMessages list. The localization action will still be attempted, even if there are errors.

validate

Successful creation of language worksheet from the input report.

Content-Type

Typically, the location of the persistent report resource, if there is one involved. Not applicable in this situation because results are returned directly to the user.

Location

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

Error

application/vnd.sas.error

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

Get localization worksheet

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

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 list of links to top-level resources and operations available from the root of the API.

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.

Name	Type	Required	Description
xmlns	string	true	The XML Schema to which the object conforms.
label	string	false	User's name for the report.
modifiedBy	string	false	Last modifying user id.
dateCreated	string<date-time>	false	Date of report creation.
dateModified	string<date-time>	false	Date of last modification.
lastModifiedApplicationName	string	false	User-readable name of application name that last modified.
createdBy	string	false	Creating user id.
createdApplicationName	string	false	User-readable name of application, if any.
createdLocale	string	false	Locale of the report when first created and serialized.
createdVersion	string	false	Schema version of report when created.

Status	Meaning	Description
201	Created	Successful creation of language worksheet from the input report.	Headers	Schema
400	Bad Request	The request was invalid. Some error in the request resulted in failure to perform the action. See the error codes table for further details.	Headers	Schema

Get localization worksheet

Request Samples

Response Samples

Path Parameters

Query Parameters

Request Body

Responses