{urn}/manifest/{derivativeUrn}
Note: This operation is deprecated. Beyond December 2022 we will only provide minimal support for this operation. So, please do not use this operation to download derivatives. Instead, use Fetch Derivative Download URL to obtain a download URL and a set of signed cookies to securely download derivatives.
Downloads the derivative specified by the derivativeUrn URI parameter, which was generated from the source model specified by the urn URI parameter.
Note that the Model Derivative API uses 2 types of URNs. The design URN is generated when you upload the source design file to APS, and is used when calling most of the Model Derivative operations. A derivative URN is generated for each translated output file format, which is the URN you specify as the derivativeUrn URI parameter in this endpoint. To obtain the derivative URN, inspect the manifest of the translation job. Use Fetch Manifest to obtain the manifest of the translation job. See the tutorial Translate a Source File for a demonstration on how to obtain the deriviative URN and how to download a derivative.
Note: 3D SVF2 derivatives cannot be downloaded.
Tip: Before calling this endpoint, call Check Derivative Details to determine the total content length. If the derivative is large, use the Range header to download the derivative in chunks.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/manifest/{derivativeUrn} |
| Method and URI (EMEA) | GET https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/manifest/{derivativeUrn} |
| Authentication Context | user context optional |
| Required OAuth Scopes | data:read or viewables:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via
POST /authentication/v2/token. |
| Range number | This is the standard RFC 2616 range request header. It only supports one range specifier per request:
1. Range:bytes=0-63 (returns the first 64 bytes)
2. Range:bytes=64-127 (returns the second set of 64 bytes)
3. Range:bytes=1022- (returns all the bytes from offset 1022 to the end)
4. If the range header is not specified, the whole content is returned.
|
| region enum: string | Specifies the data center where the specified manifest and derivative are stored in. Possible values are:
Note:
|
Request
URI Parameters
| urn string | The URL safe Base64 encoded URN of the source design. |
| derivativeUrn string | The URL-encoded URN of the derivatives. The URN is retrieved from the Fetch Manifest operation. |
Response
HTTP Status Code Summary
| 200 OK | Success. |
| 206 PARTIAL CONTENT | Partial content of the derivative is returned. |
| 400 BAD REQUEST | Invalid request. E.g., the input URN format is invalid, or the range header is specified but not formatted correctly. |
| 401 UNAUTHORIZED | Invalid authorization header. |
| 403 FORBIDDEN | Access denied regardless of authorization status. |
| 404 NOT FOUND | Endpoint does not exist. |
| 413 REQUEST ENTITY TOO LARGE | The resource exceeded the maximum length (256 MB); use range request instead. |
| 500 INTERNAL SERVICE ERROR | Unexpected service interruption |
Response
HTTP Headers
| Content-Type string | application/octet-stream. |
| Content-Length string | Denotes the size of the derivative in bytes. |
| Etag string | Determines whether there is a change in the content of the request resource. |
| x-ads-app-identifier string | The service identifier comprise 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. |
| x-ads-troubleshooting string | Provides information about the server failure. |
Response
Body Structure (200)
The body response is a binary stream of the requested derivative.
Example 1
Successful retrieval of a complete derivative (200)
Request
curl -X 'GET'\
-H 'Authorization: Bearer ztcaB2R0f92bsV6iV0bSDgwmSVaW' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest/urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf'
Response
Status Code: 200 OK
Content-Type=application/octet-stream
Content-Length:1658
Etag: urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf
x-ads-app-identifier:platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-startup-time:Wed May 11 14:03:54 CST 2016
x-ads-duration:280 ms
with chunked content body
Example 2
Successful retrieval of a partial derivative (206)
Request
curl -X 'GET' \
-H 'Authorization: Bearer ztcaB2R0f92bsV6iV0bSDgwmSVaW' \
-H 'Range: bytes=0-100' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest/urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf'
Response
Status Code: 206 Partial Content
Content-Range=bytes 0-100/1658
Content-Type=application/octet-stream
Content-Length:1658
Etag: urn%3Aadsk.viewing%3Afs.file%3AdXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA%2Foutput%2F1%2FA5.svf
x-ads-app-identifier:platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-startup-time:Wed May 11 14:03:54 CST 2016
x-ads-duration:280 ms
with chunked partial content body