GET /modelderivative/v2/designdata/{urn}/metadata/{modelGuid}
Retrieves the structured hierarchy of objects, known as an object tree, from the specified Model View (Viewable) within the specified source design. The object tree represents the arrangement and relationships of various objects present in that Model View.
Note: A design file must be translated to SVF or SVF2 before you can retrieve its object tree.
Before you call this operation:
- Use the
List Model Views </en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-GET/>_ operation to obtain the list of Model Views in the source design. - Pick the ID of the Model View you want to query and specify that ID as the value for the
modelGuidparameter.
Servers
- https://developer.api.autodesk.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
modelGuid |
String | Yes |
The ID of the Model View you are extracting the object tree from. Use the |
urn |
String | Yes |
The URL-safe Base64 encoded URN of the source design. |
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:
Note:
Valid values:
|
region |
String | No |
Specifies the data center where the manifest and derivatives of the specified source design are stored. Possible values are:
Valid values:
|
x-ads-force |
Boolean | No |
|
Accept-Encoding |
String | No |
A comma separated list of the algorithms you want the response to be encoded in, specified in the order of preference. If you specify |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
forceget |
String | No |
|
level |
String | No |
Specifies how many child levels of the hierarchy to return, when the |
objectid |
Integer | No |
If specified, retrieves the sub-tree that has the specified Object ID as its parent node. If this parameter is not specified, retrieves the entire object tree. |
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.