RestApiCategories.visualizationAndReports.desc

visualization_and_reports

2023.10

2023.03

2024.03

This API is deprecated as of 2021.2.6 and will be removed in a future release.

Replacement functionality is available in the "visualAnalytics" API and is documented here: https://developer.sas.com/apis/rest/Visualization/#export-svg-image-of-report-or-report-object

The reportImages API delivers SVG images representing elements of a report. The images are suitable to the current user, taking row-level-permissions and other factors into consideration.


Report Images

Viya_35

The reportImages API delivers SVG images representing elements of a report. The images are suitable to the current user, taking row-level-permissions and other factors into consideration.

This operation is used by [POST /jobs](#op:createJob) to return the `GET` links.

This operation uses an explicit format modifier ('.svg').  Doing so is to support the primary use case of embedding the link in a web page or other such context where the client cannot pass an 'Accept:' header to specify the image type.

This URL is secured, and valid only for the current user.

By protocol, SVG images are always XML. The media type is always 'image/svg+xml'.

Optional ETag. On a match, 304 (not modified) is returned.

If-None-Match

The system-generated ID returned with the completed job (in the 'image' link).

imageId

The image is returned. Caching headers (Cache-Control, Expires, Pragma) are returned encouraging the browser to cache this image.

ETag

Header returned encouraging the browser to cache this image.

Cache-Control

Expires

Pragma

If the client-supplied entity tag (If-None-Match) matches the current state, the client's image is current.   Nothing is then returned.

Error

application/vnd.sas.error

Either the imageId cannot be found, or the underlying image is not in the database. <p> If a user other than the one who generated the image uses this link, it is considered a security violation, and a 404 is returned so that the caller does not know the link is an otherwise-valid value. </p>

Content-Type

Get image

A link to a related operation or resource.

Link

Primary media type of this service. This media type represents the job to obtain the requested images. When the job is completed, the images element contains one object per image returned. Each object contains metadata about the image such as section, name, and size, and also a link to get the actual image and other relevant links. After the "report analysis" phase is complete, the metadata for each image is available (excepting the URI to get the image). A client can use this metadata to know that image 1 is a pie chart, image 2 is a bar chart, and image 3 is a table, possibly showing a facsimile if several seconds pass and the job has not completed.

The Operation to Create Images

Metadata about the image, including state and links. Terminal states are "completed" and "failed". Completed images have link relation "image" to download the image; the URI is suitable for a browser's IMG tag.

Describes an Individual Image

This represents the input to create the job to get the image(s). Parameters "reportUri" and "size" are required. A version of the [createJob resource](#op:createJobWithParams) exists that takes all of these values as request parameters.

Job Request Details

Report Element Name and Size

Paging details for page-oriented requests. Note when included in a request, must be null if "returnMultiple" is false, must not be null if "returnMultiple" is true.


Paging Options

Object returned if paging had been requested

Paging State

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

Thumbnail Job

A request to create a new job that creates or delivers a thumbnail.

Thumbnail Request

Sizing options; providers should honor values suitable to the type of object for which they provide thumbnails, and clients should supply values suitable to their presentation needs.


Sizing Options

Thumbnail

This object describes accessibility requests; providers are not required to honor this

Status	Meaning	Description
200	OK	The image is returned. Caching headers (Cache-Control, Expires, Pragma) are returned encouraging the browser to cache this image.	Headers	Schema
304	Not Modified	If the client-supplied entity tag (If-None-Match) matches the current state, the client's image is current. Nothing is then returned.	Headers	Schema
404	Not Found	Either the imageId cannot be found, or the underlying image is not in the database. <p> If a user other than the one who generated the image uses this link, it is considered a security violation, and a 404 is returned so that the caller does not know the link is an otherwise-valid value. </p>	Headers	Schema

Get image

Request Samples

Response Samples

Path Parameters

Header Parameters

Responses