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 hides the job architecture and *directly* generates and returns the image. It blocks synchronously until the image is ready or timeout occurs (default 10 seconds). If a timeout occurs, a redirect is returned to the browser, redirecting back to this operation for browser liveness purposes. Use of this operation is discouraged. Using more than one can starve a browser's requests queue, as some browsers are limited to 6 active queries per site. Also, the redirect technique employed can fail in the browser after too many redirects, as some browsers allow only 10 redirects. Any client capable of following the job pattern should NOT use this direct operation. Parameters `reportUri` and `size` are required.

The report from which to generate images.

reportUri

The type of image to render. <ul> <li><code>thumbnail</code> -- selects a suitable report element and reduces the detail to better render at a smaller size. </li> <li><code>normal</code> -- selects a suitable report element, but there is no reduction of detail.</li> <li><code>entireSection</code> -- the entire section (page).</li> </ul>

layoutType

The selected operation. <ul> <li><code>report</code> -- get a single image, representing the entire report. <li><code>perSection</code> -- get one image per section. <li><code>visualElements</code> -- specify the visual elements to render in parameter <code>visualElementNames</code> or <code>visualElementName</code> for the /directImage operation. </ul>

selectionType

In addition to the default "svg" for SVG image generation, "png" is now supported and results in a png image being created.

imageType

The only non-empty value supported is "highContrast", which results in a high contrast image being rendered.

style

If true, bypass caches and generate a new image.

refresh

The section to render. This parameter applies when <code>layoutType==entireSection</code>.

sectionIndex

visualElementName

The size of the rendered image. Format is <code>widthxheight</code>, with no spaces. For example, "300x200".

size

The number of seconds to wait for the result. When this expires, a "redirect" is returned to continue the waiting process. Use caution when setting; some browsers abort after 10 redirects.

wait

ETag

Header returned encouraging the browser to cache this image.

Cache-Control

Expires

Pragma

The operation could not be completed before the wait time expired. This redirect (See Other) continues the process of waiting for the image.  It is used (rather than extending the wait period) to provide some liveness to the browser's transmit queue.  Note that this redirect is common, clients that cannot follow a redirect must either not use this method or specify a very long timeout.

A URI back to this service to wait for this image.

Location

Error

application/vnd.sas.error

Content-Type

An internal service error was returned by one of the services that this operation uses. The response object contains error text and codes to diagnose it.

Return the report 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 SVG image is returned.	Headers	Schema
303	See Other	The operation could not be completed before the wait time expired. This redirect (See Other) continues the process of waiting for the image. It is used (rather than extending the wait period) to provide some liveness to the browser's transmit queue. Note that this redirect is common, clients that cannot follow a redirect must either not use this method or specify a very long timeout.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
500	Internal Server Error	An internal service error was returned by one of the services that this operation uses. The response object contains error text and codes to diagnose it.	Headers	Schema

Return the report image

Request Samples

Response Samples

Query Parameters

Responses

Name	Type	Required	Description
imageType	string	false	In addition to the default "svg" for SVG image generation, "png" is now supported and results in a png image being created. Allowed values: svgpng Default: svg
layoutType	string	false	The type of image to render. thumbnail -- selects a suitable report element and reduces the detail to better render at a smaller size. normal -- selects a suitable report element, but there is no reduction of detail. entireSection -- the entire section (page). Allowed values: thumbnailnormalentireSection Default: thumbnail
refresh	boolean	false	If true, bypass caches and generate a new image. Default: false
sectionIndex	integer<int32>	false	The section to render. This parameter applies when layoutType==entireSection. Default: 0
selectionType	string	false	The selected operation. report -- get a single image, representing the entire report. perSection -- get one image per section. visualElements -- specify the visual elements to render in parameter visualElementNames or visualElementName for the /directImage operation. Allowed values: reportperSectionvisualElements Default: report
size	string	false	The size of the rendered image. Format is widthxheight, with no spaces. For example, "300x200". Default: 268x151
style	string	false	The only non-empty value supported is "highContrast", which results in a high contrast image being rendered. Allowed values: (null/empty string)highContrast
visualElementName	string	false	The report element to render.
wait	number<float>	false	The number of seconds to wait for the result. When this expires, a "redirect" is returned to continue the waiting process. Use caution when setting; some browsers abort after 10 redirects. Default: 10
reportUri	string	true	The report from which to generate images.