POST /modelderivative/v2/designdata/{urn}/references

Specifies the location of the files referenced by the specified source design.

When you call Create Translation Job </en/docs/model-derivative/v2/reference/http/job-POST>_, set checkReferences to true. The Model Derivative service will then use the details you specify in this operation to locate and download the referenced files.

Servers

https://developer.api.autodesk.com

Path parameters

Name	Type	Required	Description
`urn`	String	Yes	The Base64 (URL Safe) encoded design URN.

Request headers

Name Type Required Description

Name	Type	Required	Description
`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"

region

String

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"

Request body fields

Name	Type	Required	Description
`region`	String	No	Specifies where the referenced files are stored. Possible values are: `US` - Data center for the US region. `EMEA` - Data center for the European Union, Middle East, and Africa. `AUS` - (Beta) 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"`
`references[]`	Array	Yes	An array of objects, where each object represents a referenced file.
`references[].relativePath`	String	Yes	The path to the referenced file, relative to the top level component. By default, it is set to `""`, which means that the referenced file and top level component are in the same folder.
`references[].urn`	String	Yes	The URN of the referenced file.
`references[].filename`	String	Yes	The file name of the referenced file. By default, it is set to `""` and the referenced file will be downloaded by its `urn` and placed relative to the top-level component using `relativePath`.
`references[].metadata`	Object	No	An object to hold custom metadata.
`urn`	String	Yes	The URL safe Base64 encoded URN of the source design. Mandatory if the Base64 encoded urn in the request URL is a logical URN.
`filename`	String	Yes	The file name of the top level component. By default, it is set to `""` and the file will be download with its `urn`.

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.