RestApiCategories.visualizationAndReports.desc

visualization_and_reports

2023.03

2023.10

2024.09

2024.10

2024.08

2024.03

2024.11

2024.12

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

Insert the translator's language worksheet into an existing report and save the report. This saves the human translator's strings for the specified locale so that the report can be generated later in the locale's language.  This action returns no content.

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

The body of the request is the translation worksheet.

The etag identifier from the last GET of the report.

If-Match

The report from which the original report should be read.

reportId

The locale for which the translation should be extracted.

translationLocale

See code 204.  This is a departure from a typical PUT, which would return the modified object, but in this case, returning the modified report is undesirable.

ETag

Worksheet was inserted into the report. No content returned.

Identifier of modified report for precondition of subsequent PUT.

Location of modified report resource.  Should be duplicate information that matches the input parameter.

Location

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

Error

application/vnd.sas.error

Content-Type

The header If-Match Etag value did not match.

The precondition header If-Match was not provided.

Update localization in a report

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

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.

Validation Response

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

Name	Type	Required	Description
locale	string	false	A valid IETF language tag.
lines	array [string]	false	Individual lines with translatable strings. Each line has a substructure of `identifier=value`, where the value part is what should be translated.
links	array [Link]	false	Link objects, as described in SAS standards documentation.
version	integer	false	Standard field. This media type's schema version number. This representation is version 1.

Status	Meaning	Description
200	OK	See code 204. This is a departure from a typical PUT, which would return the modified object, but in this case, returning the modified report is undesirable.	Headers
204	No Content	Worksheet was inserted into the report. No content returned.	Headers
400	Bad Request	The request was invalid.	Headers	Schema
412	Precondition Failed	The header If-Match Etag value did not match.	Headers	Schema
428	Precondition Required	The precondition header If-Match was not provided.	Headers	Schema

Update localization in a report

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses

Name	Type	Required	Description
reportId	string	true	The report from which the original report should be read.
translationLocale	string	true	The locale for which the translation should be extracted.