Reference Guide
REST API Reference
This page contains a list of operations possible with the Model Derivative API.
Informational
Operation | HTTP Request | Description |
---|---|---|
List Supported Formats | GET /formats | Returns the supported output formats for each input format. |
Jobs
Operation | HTTP Request | Description |
---|---|---|
Create Translation Job | POST /job | Requests for the source design to be asynchronously translated into the specified derivative formats. |
Specify References | POST /{urn}/references | Specifies the location of files referenced by the specified source design. |
Fetch Manifest | GET /{urn}/manifest | Returns the manifest for the specified source design, which contains information about the status of any ongoing translation jobs. |
Manifest
Operation | HTTP Request | Description |
---|---|---|
Fetch Manifest | GET /{urn}/manifest | Returns the manifest of the specified source design, which contains information about its derivatives, including output URNs and statuses of any ongoing translation jobs. |
Delete Manifest | DELETE /{urn}/manifest | Deletes the manifest and all derivatives of the specified source design. |
Derivatives
Operation | HTTP Request | Description |
---|---|---|
Download Derivative |
GET /{urn}/manifest/{derivativeUrn} | Downloads a derivative. |
Check Derivative Details | HEAD /{urn}/manifest/{derivativeUrn} | Returns information about the specified derivative. |
Fetch Derivative Download URL | GET /{urn}/manifest/{derivativeUrn}/signedcookies | Returns a download URL and signed cookies to securely download a derivative. |
Metadata
Operation | HTTP Request | Description |
---|---|---|
List Model Views | GET /{urn}/metadata | Returns the model view IDs for a model. |
Fetch Object Tree | GET /{urn}/metadata/{modelGuid} | Returns the hierarchical object tree of a specified model view. |
Fetch All Properties | GET /{urn}/metadata/{modelGuid}/properties | Returns all properties of specified objects in a specified model view. |
Fetch Specific Properties | POST /{urn}/metadata/{modelGuid}/properties:query | Returns specified properties of specified objects in a specified model view. |
Thumbnails
Operation | HTTP Request | Description |
---|---|---|
Fetch Thumbnail | GET /{urn}/thumbnail | Generates and returns a thumbnail of the specified design. |