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:

Servers

Path parameters

Name Type Required Description
modelGuid String Yes

The ID of the Model View you are extracting the object tree from. Use the List Model Views </en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-GET>_ operation to get the IDs of the Model Views in the source design.

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:

  • latest - (Default) Return SVF2 Object IDs.
  • fallback - Return SVF Object IDs.

Note:

  1. This parameter applies only to designs with legacy SVF derivatives generated by the BIM 360 Docs service.

  2. 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.

  3. 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"
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.
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 gzip or *, content is compressed and returned in gzip format.

Query parameters

Name Type Required Description
forceget String No

true: Retrieves large resources, even beyond the 20 MB limit. If exceptionally large (over 800 MB), the system acts as if forceget is false.

false: (Default) Does not retrieve resources if they are larger than 20 MB.

level String No

Specifies how many child levels of the hierarchy to return, when the objectid parameter is specified. Currently supports only level = 1.

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.