Fetch Thumbnail
GET
{urn}/thumbnail
Downloads a thumbnail of the specified source design.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/thumbnail |
Method and URI (EMEA) | GET https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/thumbnail |
Authentication Context | user context optional |
Required OAuth Scopes | data:read or viewables:read |
Data Format | binary file stream |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via POST /authentication/v2/token |
region enum:string | Specifies the data center where the manifest and derivative of the specified source design are stored in. Possible values are:
|
* Required
Request
URI Parameters
urn string | The URL safe Base64 encoded URN of the source design. |
Request
Query String Parameters
width enum: int | Width of thumbnail.
Possible values:
100 , 200 , 400 .If
width is omitted, but height is specified, width defaults to height .If both
width and height are omitted, the server will return a
thumbnail closest to 200, if such a thumbnail is available. |
height enum: int | Height of thumbnail.
Possible values:
100 , 200 , 400 .If
height is omitted, but width is specified, height defaults to width .If both
width and height are omitted, the server will return a
thumbnail closest to 200, if such a thumbnail is available. |
Response
HTTP Status Code Summary
200 OK | Success |
400 BAD REQUEST | Invalid request |
401 UNAUTHORIZED | Invalid authorization header |
403 FORBIDDEN | Access denied regardless of authorization status |
404 NOT FOUND | Endpoint does not exist |
500 INTERNAL SERVICE ERROR | Unexpected service interruption |
Response
HTTP Headers
x-ads-name string | File name of the thumbnail. |
x-ads-size enum: array: int | Thumbnail size
Possible values:
[100,100] , [200,200] , [400,400] |
x-ads-role enum: string | The source of the thumbnail. Possible values:
-
rendered : Generated as a result of this request.-
extracted : Existing thumbnail obtained from the source design. |
x-ads-job-status enum: string | The status of the thumbnail generating process.
Possible values:
-
inprogress : The thumbnail generating process is still in progress.-
success : The thumbnail was generated successfully.-
failed , : The thumbnail generating process failed.-
timedout : The thumbnail generating process timed out. |
x-ads-app-identifier string | The service identifier, including service name, version, and environment |
x-ads-startup-time string | The service startup time with data format EEE MMM dd HH:mm:ss Z yyyy |
x-ads-duration string | The request duration in milliseconds, in the format <int> ms |
x-ads-troubleshooting string | Information about the server failure, if any |
Response
Body Structure (200)
The body response is a binary stream of the thumbnail.
Example 1
Successful retrieval of a thumbnail (200)
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/thumbnail'
Response
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Origin: *
Cache-Control: public, max-age=86400
Content-Type: image/png
x-ads-app-identifier: platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-duration: 142 ms
x-ads-name: 0.svf.png01_thumb_100x100.png
x-ads-job-status: success
x-ads-role: rendered
x-ads-size: [100, 100]
x-ads-startup-time: Thu May 19 10:38:55 UTC 2016
transfer-encoding: chunked
Connection: keep-alive
Show More
Example 2
Successful retrieval of a thumbnail with specified dimensions (200)
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/thumbnail?width=400&height=400'
Response
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Origin: *
Cache-Control: public, max-age=86400
Content-Type: image/png
x-ads-app-identifier: platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-duration: 142 ms
x-ads-name: 0.svf.png01_thumb_400x400.png
x-ads-job-status: success
x-ads-role: rendered
x-ads-size: [400, 400]
x-ads-startup-time: Thu May 19 10:40:25 UTC 2016
transfer-encoding: chunked
Connection: keep-alive
Show More