Get report images using request body

post/jobs

Internal-Use Only

Creates an asynchronous job for obtaining SVG images for the report. All the functionality of the create job with parameters operation is supported, plus the ability to specify a list of report elements to render, each with its own size. (new w/ version 4, body member "style" similar to "style" request parameter elsewhere.)

Request Samples

application/vnd.sas.report.images.job.request+json
1

Response Samples

201
application/vnd.sas.report.images.job+json
1{
2  "id": "d145d576-78d0-42d4-a5fc-569cd0533903",
3  "version": 2,
4  "state": "running",
5  "durationMSec": 155,
6  "creationTimeStamp": "2017-11-17T18:46:59.774000Z",
7  "links": [
8    {
9      "method": "GET",
10      "rel": "self",
11      "href": "/reportImages/jobs/d145d576-78d0-42d4-a5fc-569cd0533903",
12      "uri": "/reportImages/jobs/d145d576-78d0-42d4-a5fc-569cd0533903",
13      "type": "application/vnd.sas.report.images.job+json"
14    },
15    {
16      "method": "GET",
17      "rel": "state",
18      "href": "/reportImages/jobs/d145d576-78d0-42d4-a5fc-569cd0533903/state",
19      "uri": "/reportImages/jobs/d145d576-78d0-42d4-a5fc-569cd0533903/state",
20      "type": "text/plain"
21    }
22  ],
23  "images": [
24    {
25      "sectionIndex": 0,
26      "sectionName": "vi6",
27      "sectionLabel": "Page 1",
28      "elementName": "ve41",
29      "modifiedTimeStamp": "2017-11-16T18:19:23.600000Z",
30      "visualType": "Table",
31      "size": "268x151",
32      "state": "completed",
33      "links": [
34        {
35          "method": "GET",
36          "rel": "image",
37          "href": "/reportImages/images/K738605462B1380786238.svg",
38          "uri": "/reportImages/images/K738605462B1380786238.svg",
39          "type": "image/svg+xml"
40        }
41      ]
42    },
43    {
44      "sectionIndex": 1,
45      "sectionName": "vi47",
46      "sectionLabel": "Page 2",
47      "elementName": "ve50",
48      "modifiedTimeStamp": "2017-11-12T14:05:13.450000Z",
49      "visualType": "pie",
50      "size": "268x151",
51      "state": "running",
52      "links": [
53        {
54          "method": "GET",
55          "rel": "staleImage",
56          "href": "/reportImages/images/K738605462B1234567890.svg",
57          "uri": "/reportImages/images/K738605462B1234567890.svg",
58          "type": "image/svg+xml"
59        }
60      ]
61    }
62  ]
63}

Query Parameters

Name	Type	Required	Description
refresh	boolean	false	If true, bypass caches and generate a new image. Default: false
wait	number<float>	false	The number of seconds to wait for an update before returning from the "long poll". The maximum is 30 seconds. Default: 0.5

Header Parameters

Name	Type	Required	Description
Accept-Language	string	false	The user's locale. For non-thumbnail operations, this locale is a factor for both rendering and caching. For thumbnail requests, typically only the right-to-left aspect is considered. Thumbnails do not typically include localizable content, and consequently are shareable among users with different locales. For details, see Accept-Language.
Accept-Locale	string	false	A "format locale" distinct from the user's language (Accept-Language). Usage and syntax is similar to Accept-Language.

Request Body

The job details here parallel those in the operation that uses request parameters. In addition, supports an array of name/size pairs to specify multiple renderings.

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 exists that takes all of these values as request parameters.

Example:

{"version":3,"reportUri":"/reports/reports/ffdfe936-80a9-4969-a786-4a314df13f3f","layoutType":"thumbnail","size":"268x151","refresh":true}

Name	Type	Required	Description
reportUri	string	true	The report from which to generate images.
layoutType	string	false	The type of image. Allowed values: thumbnailnormalentireSection Default: thumbnail
selectionType	string	false	The type of operation selected. -"report" gets a single image that represents the entire report. -"perSection" gets one image per section. -"visualElements" enables the caller to specify the visual elements to render (in parameter "visualElementNames"). Allowed values: reportperSectionvisualElementspaging Default: report
size	string	false	The image size. Format is widthxheight, with no spaces. For example, "268x151".
imageType	string	false	(v3) the image's type. "svg" (default), or "png". Allowed values: svgpng
specificVisualElements	array [Report Element Name and Size]	false	An array of name/size pairs, each representing a visual element to render.
sectionIndex	integer<int32>	false	The section (page) to render. Applies only when layoutType==entireSection. Default: 0
refresh	boolean	false	If true, bypass caches and generate a new image. Default: false
renderLimit	integer<int32>	false	Limit how many images to render. For no limit, set to -1. Clients can specify "1" to quickly get the first image and how many remaining images are available. Default: -1
pagingOptions	Paging Options	false	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.
version	integer<int32>	false	This media type's schema version number. This representation is version 3.

Responses

Status	Meaning	Description
201	Created	The requested job has both been created, and is in the "completed" state; the image(s) are ready.	Headers	Schema
202	Accepted	The requested job has been created but has not completed.	Headers	Schema
400	Bad Request	The request was invalid.	Headers	Schema
404	Not Found	The report could not be found.	Headers	Schema