{urn}/manifest
Retrieves the manifest of the specified source design.
The manifest is a JSON file containing information about all the derivatives translated from the specified source design. It contains information such as the URNs of the derivatives, the translation status of each derivative, and much more.
The first time you translate a source design, the Model Derivative service creates a manifest for that source design. Thereafter, every time you translate that source design, even to a different format, the Model Derivative service updates that manifest. It does not create a new manifest. Instead, it keeps track of all derivatives of that design.
When the Model Derivative service starts a translation job (as a result of a request you make using Create Translation Job), it keeps on updating the manifest at regular intervals. So, you can use the manifest to check the status and progress of each derivative that is being generated. When multiple derivatives have been requested each derivative may complete at a different time. So, each derivative has its own status
attribute. The manifest also contains an overall status
attribute. The overall status
becomes complete
when the status
of all individual derivatives become complete.
Once the translation status of a derivative is complete
you can download the URN.
Note: You cannot download 3D SVF2 derivatives.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/manifest |
Method and URI (EMEA) | GET https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/manifest |
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 token |
Accept-Encoding string | The encoding method you prefer to receive the response. If you specify gzip or * , content is compressed and returned in gzip format. |
region enum: string | Specifies the data center where the specified manifest is stored in. Possible values are:
Note:
|
Request
URI Parameters
urn string | The URL-safe Base64 encoded URN of the source design. |
Response
HTTP Status Code Summary
200 OK | Success. |
400 BAD REQUEST | The request is invalid. E.g., the payload was not formatted correctly. |
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-app-identifier string | The service identifier, comprising of the service name, version and environment. |
x-ads-startup-time string | The service startup date and time in the EEE MMM dd HH:mm:ss Z yyyy format. |
x-ads-duration string | The request duration in milliseconds. |
x-ads-troubleshooting string | Provides information about the server failure. |
Response
Body Structure (200)
urn string | The URL-safe Base64 encoded URN of the source design. |
type string | The type of data that is returned. Always manifest . |
progress string | Overall progress of all translation jobs for the source design. Possible values: complete , ##% . |
status string | Overall status of all translation jobs for the source design. Possible values: pending , success , inprogress , failed , timeout |
hasThumbnail bool |
|
region string | The region where the source design and its derivatives are stored. Possible values: US , EMEA , and AUS . |
derivatives array: object | An array of objects, where each object represents a derivative of the source design. |
name string | Name of the derivative. |
hasThumbnail bool |
|
outputType string | The file type/format of the derivative. Possible values: dwg , fbx , ifc , iges , obj , step , stl , svf , svf2 , thumbnail |
status string | Status of the translation job generating this derivative. Possible values: pending , inprogress , success , failed , timeout |
progress string | How far the translation job generating this derivative has progressed. Possible values: complete , ##% . |
messages array: object | Messages that are logged to the manifest during translation. For example, error messages and warning messages. |
type string | Indicates the type of the message. For example, warning indicates a warning message and error indicates an error message. |
code string | The ID of the message. For example, the error code reported by an error message. |
code string | A human-readable explanation of the event being reported. |
children array: object | An array of objects, where each object represents a resource file generated for the derivative during translation. For example, a Model View (Viewable) of the source design. |
guid string | An ID that uniquely identifies the resource file. |
type string | Type of resource this JSON object represents. |
role string | File type of the resource file. |
mime string | The MIME type of the content of the resource file. |
name string | The name of the resource file. |
isMasterView bool |
This attribute is present only if:
|
phaseNames string or
array: string | The name of the phase the resource file was generated from. This attribute is present only on Model Views (Viewables) generated from a Revit source design. This attribute can be a string (for Revit non-sheet 2D or 3D views) or an array of strings (for Revit sheet views). |
phaseIds string or
array: string | The unique ID of the phase the resource file was generated from. This attribute is present only on Model Views (Viewables) generated from a Revit source design. This attribute can be a string (for Revit non-sheet 2D or 3D views) or an array of strings (for Revit sheet views). |
mime string | MIME type of the entity. |
urn string | The URN of the resource file, which you can use as its unique ID. |
progress string | How far the translation job generating this resource file has progressed. |
status string | Status of the translation job generating this resource file; Possible values: pending , inprogress , success , failed , timeout |
messages array: object | Messages that are logged to the manifest during translation. For example, error messages and warning messages. |
type string | Indicates the type of the message. For example, warning indicates a warning message and error indicates an error message. |
code string | The ID of the message. For example, the error code reported by an error message. |
message array: string | A human-readable explanation of the event being reported. |
children array: object | An optional array of objects, where each object (of type children ) represents another resource file generated for this resource. |
Example 1
This example demonstrates the response to a request for a manifest, but translation has not started as of yet.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest'
Response
{
"type": "manifest",
"hasThumbnail": "false",
"status": "pending",
"progress": "0% complete",
"region": "US",
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA",
"derivatives": [
]
}
Example 2
This example demonstrates the response to a request for a manifest, but translation has not yet completed.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest'
Response
{
"type": "manifest",
"hasThumbnail": "true",
"status": "inprogress",
"progress": "99% complete",
"region": "US",
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA",
"derivatives": [
{
"name": "A5.iam",
"hasThumbnail": "true",
"status": "success",
"progress": "99% complete",
"outputType": "svf",
"children": [
{
"guid": "d998268f-eeb4-da87-0db4-c5dbbc4926d0",
"type": "geometry",
"role": "3d",
"name": "Scene",
"status": "success",
"progress": "99% complete",
"hasThumbnail": "true",
"children": [
{
"guid": "4f981e94-8241-4eaf-b08b-cd337c6b8b1f",
"type": "resource",
"progress": "99% complete",
"role": "graphics",
"mime": "application/autodesk-svf"
},
{
"guid": "d718eb7e-fa8a-42f9-8b32-e323c0fbea0c",
"type": "resource",
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/output/1/A5.svf.png01_thumb_400x400.png",
"resolution": [
400.0,
400.0
],
"mime": "image/png",
"role": "thumbnail"
},
{
"guid": "34dc340b-835f-47f7-9da5-b8219aefe741",
"type": "resource",
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/output/1/A5.svf.png01_thumb_200x200.png",
"resolution": [
200.0,
200.0
],
"mime": "image/png",
"role": "thumbnail"
},
{
"guid": "299c6ba6-650e-423e-bbd6-3aaff44ee104",
"type": "resource",
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/output/1/A5.svf.png01_thumb_100x100.png",
"resolution": [
100.0,
100.0
],
"mime": "image/png",
"role": "thumbnail"
}
]
}
]
}
]
}
Example 3
This example demonstrates the response to a request for a manifest, but translation has failed.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/manifest'
Response
{
"type": "manifest",
"hasThumbnail": "false",
"status": "failed",
"progress": "complete",
"region": "US",
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA",
"derivatives": [
{
"name": "A5.iam",
"hasThumbnail": "false",
"status": "failed",
"progress": "complete",
"messages": [
{
"type": "warning",
"message": "The drawing's thumbnails were not properly created.",
"code": "TranslationWorker-ThumbnailGenerationFailed"
}
],
"outputType": "svf",
"children": [
{
"guid": "d998268f-eeb4-da87-0db4-c5dbbc4926d0",
"type": "geometry",
"role": "3d",
"name": "Scene",
"status": "success",
"messages": [
{
"type": "warning",
"code": "ATF-1023",
"message": [
"The file: {0} does not exist.",
"C:\\Users\\ADSK\\Documents\\A5\\Top.ipt"
]
},
{
"type": "warning",
"code": "ATF-1023",
"message": [
"The file: {0} does not exist.",
"C:\\Users\\ADSK\\Documents\\A5\\Bottom.ipt"
]
},
{
"type": "error",
"code": "ATF-1026",
"message": [
"The file: {0} is empty.",
"C:/worker/viewing-inventor-lmv/tmp/job-1/5/output/1/A5.svf"
]
}
],
"progress": "complete",
"hasThumbnail": "false",
"children": [
{
"guid": "4f981e94-8241-4eaf-b08b-cd337c6b8b1f",
"type": "resource",
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/output/1/A5.svf",
"role": "graphics",
"mime": "application/autodesk-svf"
}
]
}
]
}
]
}
Example 4
This example demonstrates the successful response to a request for a manifest generated for a Revit model translated to the SVF format.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/manifest'
Response
{
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0",
"derivatives": [
{
"hasThumbnail": "true",
"children": [
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/model.sdb",
"role": "Autodesk.CloudPlatform.PropertyDatabase",
"mime": "application/autodesk-db",
"guid": "6fac95cb-af5d-3e4f-b943-8a7f55847ff1",
"type": "resource",
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/AECModelData.json",
"role": "Autodesk.AEC.ModelData",
"mime": "application/json",
"guid": "a4aac952-a3f4-031c-4113-b2d9ac2d0de6",
"type": "resource",
"status": "success"
},
{
"guid": "02efa4e8-11ec-5b90-1c0b-4775bad24b58",
"type": "geometry",
"role": "3d",
"name": "3D",
"viewableID": "92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0",
"phaseNames": "New Construction",
"status": "success",
"hasThumbnail": "true",
"progress": "complete",
"children": [
{
"guid": "92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0",
"type": "view",
"role": "3d",
"name": "3D",
"status": "success",
"progress": "complete",
"camera": [
63.460731506347656,
-69.05099487304688,
85.06072235107422,
-12.099991798400879,
6.50972843170166,
9.5,
-0.40824830532073975,
0.40824830532073975,
0.8164966106414795,
1.3879648447036743,
0,
1,
1
]
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D.svf",
"role": "graphics",
"mime": "application/autodesk-svf",
"guid": "1821b502-b91e-f9f2-56e9-2d7cb4b0f4a3",
"type": "resource"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D1.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "c70aa596-d404-714f-6795-9276087c3800",
"type": "resource",
"resolution": [
100,
100
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D2.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "6ef65d1a-4a59-111d-f1ec-4e543bd2712b",
"type": "resource",
"resolution": [
200,
200
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D4.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "2c06739e-5164-4f6d-450e-c8833fd2a2ba",
"type": "resource",
"resolution": [
400,
400
],
"status": "success"
}
]
}
],
"name": "Link Arc_2018.rvt",
"progress": "complete",
"outputType": "svf",
"status": "success"
},
{
"children": [
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview1.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "db899ab5-939f-e250-d79d-2d1637ce4565",
"type": "resource",
"resolution": [
100,
100
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview2.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "3f6c118d-f551-7bf0-03c9-8548d26c9772",
"type": "resource",
"resolution": [
200,
200
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMS9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview4.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "4e751806-0920-ce32-e9fd-47c3cec21536",
"type": "resource",
"resolution": [
400,
400
],
"status": "success"
}
],
"progress": "complete",
"outputType": "thumbnail",
"status": "success"
}
],
"hasThumbnail": "true",
"progress": "complete",
"type": "manifest",
"region": "US",
"version": "1.0",
"status": "success"
}
Example 5
This example demonstrates the successful response to a request for a manifest generated for a Revit model translated to the SVF2 format.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer-stg.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/manifest' \
Response
{
"urn": "dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0",
"derivatives": [
{
"hasThumbnail": "true",
"children": [
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/model.sdb",
"role": "Autodesk.CloudPlatform.PropertyDatabase",
"mime": "application/autodesk-db",
"guid": "6fac95cb-af5d-3e4f-b943-8a7f55847ff1",
"type": "resource",
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/AECModelData.json",
"role": "Autodesk.AEC.ModelData",
"mime": "application/json",
"guid": "a4aac952-a3f4-031c-4113-b2d9ac2d0de6",
"type": "resource",
"status": "success"
},
{
"phaseNames": "New Construction",
"role": "3d",
"hasThumbnail": "true",
"children": [
{
"guid": "92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0",
"type": "view",
"role": "3d",
"name": "3D",
"status": "success",
"progress": "complete",
"camera": [
63.460731506347656,
-69.05099487304688,
85.06072235107422,
-12.099991798400879,
6.50972843170166,
9.5,
-0.40824830532073975,
0.40824830532073975,
0.8164966106414795,
1.3879648447036743,
0,
1,
1
]
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D1.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "c70aa596-d404-714f-6795-9276087c3800",
"type": "resource",
"resolution": [
100,
100
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D2.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "6ef65d1a-4a59-111d-f1ec-4e543bd2712b",
"type": "resource",
"resolution": [
200,
200
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/Resource/3D View/3D/3D4.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "2c06739e-5164-4f6d-450e-c8833fd2a2ba",
"type": "resource",
"resolution": [
400,
400
],
"status": "success"
},
{
"role": "graphics",
"mime": "application/autodesk-svf2",
"guid": "1821b502-b91e-f9f2-56e9-2d7cb4b0f4a3",
"type": "resource"
}
],
"name": "3D",
"guid": "02efa4e8-11ec-5b90-1c0b-4775bad24b58",
"progress": "complete",
"type": "geometry",
"viewableID": "92b5dec7-790a-45b0-a5e8-cd9f76058c3a-0004bdc0",
"status": "success"
}
],
"name": "Link Arc_2018.rvt",
"progress": "complete",
"outputType": "svf2",
"status": "success"
},
{
"children": [
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview1.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "db899ab5-939f-e250-d79d-2d1637ce4565",
"type": "resource",
"resolution": [
100,
100
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview2.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "3f6c118d-f551-7bf0-03c9-8548d26c9772",
"type": "resource",
"resolution": [
200,
200
],
"status": "success"
},
{
"urn": "urn:adsk.viewing:fs.file:dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6c3ZmX3NhbXBsZV8wMi9MaW5rJTIwQXJjXzIwMTgucnZ0/output/preview4.png",
"role": "thumbnail",
"mime": "image/png",
"guid": "4e751806-0920-ce32-e9fd-47c3cec21536",
"type": "resource",
"resolution": [
400,
400
],
"status": "success"
}
],
"progress": "complete",
"outputType": "thumbnail",
"status": "success"
}
],
"hasThumbnail": "true",
"progress": "complete",
"type": "manifest",
"region": "US",
"version": "1.0",
"status": "success"
}