Get thumbnail images

post/jobs

Internal-Use Only

Creates an asynchronous job, but honors the media types and contract for a "thumbnail provider". Note with version 4 of the API, report images is now honoring the "thumbnails request" for high contrast; completing an end-to-end use case of high contrast from SAS Drive to the delivered report image thumbnail being in high contrast.

Request Samples

application/vnd.sas.thumbnails.job.request+json
1

Response Samples

201
application/vnd.sas.thumbnails.job+json
1{
2  "id": "string",
3  "state": "pending",
4  "thumbnails": [
5    {
6      "state": "pending",
7      "error": {
8        "message": "string",
9        "id": "string",
10        "errorCode": 0,
11        "httpStatusCode": 0,
12        "details": [
13          "string"
14        ],
15        "remediation": "string",
16        "errors": [
17          {}
18        ],
19        "links": [
20          {
21            "method": "string",
22            "rel": "string",
23            "uri": "string",
24            "href": "string",
25            "title": "string",
26            "type": "string",
27            "itemType": "string",
28            "responseType": "string",
29            "responseItemType": "string"
30          }
31        ],
32        "version": 0
33      },
34      "modifiedTimeStamp": "2019-08-24T14:15:22Z",
35      "links": [
36        {
37          "method": "string",
38          "rel": "string",
39          "uri": "string",
40          "href": "string",
41          "title": "string",
42          "type": "string",
43          "itemType": "string",
44          "responseType": "string",
45          "responseItemType": "string"
46        }
47      ]
48    }
49  ],
50  "error": {
51    "message": "string",
52    "id": "string",
53    "errorCode": 0,
54    "httpStatusCode": 0,
55    "details": [
56      "string"
57    ],
58    "remediation": "string",
59    "errors": [
60      {}
61    ],
62    "links": [
63      {
64        "method": "string",
65        "rel": "string",
66        "uri": "string",
67        "href": "string",
68        "title": "string",
69        "type": "string",
70        "itemType": "string",
71        "responseType": "string",
72        "responseItemType": "string"
73      }
74    ],
75    "version": 0
76  },
77  "duration": -3.402823669209385e+38,
78  "defaultThumbnailSasThemesIconKey": "string",
79  "pagingState": {
80    "start": 0,
81    "limit": 0,
82    "count": 0
83  },
84  "links": [
85    {
86      "method": "string",
87      "rel": "string",
88      "uri": "string",
89      "href": "string",
90      "title": "string",
91      "type": "string",
92      "itemType": "string",
93      "responseType": "string",
94      "responseItemType": "string"
95    }
96  ],
97  "version": -2147483648
98}

Query Parameters

Name	Type	Required	Description
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 thumbnail job details.

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

Name	Type	Required	Description
acceptItem	string	true	A media type string listing acceptable media types, possibly with quality values. Example: "image/*,text/plain;q=0.9,text/csv;q=0.8".
resourceUri	string	true	URI to the resource for which a thumbnail is needed.
resourceType	string	false	The SAS type of the resource for which a thumbnail is needed.
detailLevel	string	false	The expected level of detail. (default is "low") Allowed values: lowhigh Default: low
scope	string	false	Whether a single element is to be represented, or the entire page. (default is "element") Allowed values: elementpage Default: element
returnMultiple	boolean	false	Whether a single thumbnail is to be returned (false) or multiple thumbnails (true). (default is false) Default: false
refresh	boolean	false	Whether the freshest possible result is requested. (default is false) Default: false
sizingOptions	Sizing Options	false	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.
accessibilityOptions	Accessibility Options	false	This object describes accessibility requests; providers are not required to honor this
themeId	string	false	The client's current theme.
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	The version number of the thumbnail representation. This representation is version 1.

Responses

Status	Meaning	Description
201	Created	The job was created and is in the "completed" state. The thumbnails(s) are ready.	Headers	Schema
202	Accepted	The requested job was created but has not completed. Some of the images can be in the "completed" state. Some images might have a "staleThumbnail" link.	Headers	Schema
400	Bad Request	Bad request. The request body is not well formed.	Headers	Schema
404	Not Found	The report could not be found.	Headers	Schema