POST /modelderivative/v2/designdata/job

Creates a job to translate the specified source design to another format, generating derivatives of the source design. You can optionally:

Extract selected parts of a design and export the set of geometries in OBJ format.
Generate different-sized thumbnails.

When the translation job runs, details about the process and generated derivatives are logged to a JSON file known as a manifest. This manifest is typically created during the first translation of a source design. Subsequently, the system updates the same manifest whenever a translation is performed for that design.

If necessary, you can set the x-ads-force parameter to true. Then, the system will delete the existing manifest and create a new one. However, be aware that doing so will also delete all previously generated derivatives.

Servers

https://developer.api.autodesk.com

Request headers

Name	Type	Required	Description
`x-ads-derivative-format`	String	No	Specifies what Object IDs to return, if the design has legacy SVF derivatives generated by the BIM Docs service. Possible values are: `latest` - (Default) Return SVF2 Object IDs. `fallback` - Return SVF Object IDs. Note: This parameter applies only to designs with legacy SVF derivatives generated by the BIM 360 Docs service. The BIM 360 Docs service now generates SVF2 derivatives. SVF2 Object IDs may not be compatible with the SVF Object IDs previously generated by the BIM 360 Docs service. Setting this header to fallback may resolve backward compatibility issues resulting from Object IDs of legacy SVF derivatives being retained on the client side. If you use this parameter with one derivative (URN), you must use it consistently across the following: `Create Translation Job </en/docs/model-derivative/v2/reference/http/job-POST>`_ (for OBJ output) `Fetch Object Tree </en/docs/model-derivative/v2/reference/http/urn-metadata-modelguid-GET>`_ `Fetch All Properties </en/docs/model-derivative/v2/reference/http/urn-metadata-guid-properties-GET>`_ `Fetch Specific Properties <en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-guid-properties-query-POST>`_ Valid values: `"latest"` `"fallback"`
`region`	String	No	Specifies the data center where the manifest and derivatives of the specified source design are stored. Possible values are: `US` - (Default) Data center for the US region. `EMEA` - Data center for the European Union, Middle East, and Africa. `AUS` - Data center for the Australia region. `CAN` - Data center for the Canada region. `DEU` - Data center for the Germany region. `IND` - Data center for the India region. `JPN` - Data center for the Japan region. `GBR` - Data center for the United Kingdom region. Valid values: `"US"` `"IND"` `"AUS"` `"EMEA"` `"CAN"` `"JPN"` `"GBR"` `"DEU"`
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`x-ads-force`	Boolean	No	`true`: Forces the system to parse property data all over again. Use this option to retrieve an object tree when previous attempts have failed. `false`: (Default) Use previously parsed property data to extract the object tree.

Request body fields

Name	Type	Required	Description
`misc`	Object	No	Contains webhook configuration settings for notifying external systems about translation job events.
`misc.workflowAttribute`	Object	No	A user-defined JSON object, which you can use to set some custom workflow information. It must be less than 1KB and is ignored if `misc.workflow` is not specified.
`misc.workflow`	String	No	The workflow ID of the webhook that listens to Model Derivative events. It must be 36 characters or less and can only contain alphanumeric characters (A-Z, 0-9) and hyphens (-).
`input`	Object	Yes	Describes the attributes of the source design.
`input.rootFilename`	String	No	The file name of the top-level component of the source design. Mandatory if `compressedUrn` is set to `true`.
`input.urn`	String	Yes	The URL safe Base64 encoded URN of the source design. Note: The URN is returned as the `objectID` once you complete uploading the source design to APS. This value must be converted to a `Base64 (URL Safe) encoded <http://www.freeformatter.com/base64-encoder.html>`_ string before you can specify it for this attribute.
`input.checkReferences`	Boolean	No	`true` - Instructs the system to check for references, and if any exist, download all referenced files. Setting this parameter to `true` is mandatory when translating source designs consisting of multiple files. For example, Autodesk Inventor assemblies. `false` - (Default) Instructs the system not to check for references.
`input.compressedUrn`	Boolean	No	`true`: The source design is compressed as a zip file. If set to `true`, you need to define the `rootFilename`.' `false`: (Default) The source design is not compressed. Default value: false
`output`	Object	Yes	Describes the attributes of the requested derivatives.
`output.destination`	Object	No	(Deprecated) Specifies where to store generated derivatives. Note: Please use the `region` header instead of this attribute.
`output.destination.region`	String	No	Specifies where to store generated derivatives. Possible values are: `US` - (Default) Store derivatives at a data center for the United States of America. `EMEA` - Store derivatives at a data center for the European Union. `AUS` - (Beta) Store derivatives at a data center for the Australia region. `CAN` - Data center for the Canada region. `DEU` - Data center for the Germany region. `IND` - Data center for the India region. `JPN` - Data center for the Japan region. `GBR` - Data center for the United Kingdom region. Note: Please use the `region` header instead of this attribute.
`output.formats[]`	Array	Yes	An array of objects, where each object represents a requested derivative format. You can request multiple derivatives.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.