{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 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
modelGuid
URI parameter.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/metadata/{modelGuid} |
Method and URI (EMEA) | GET https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/metadata/{modelGuid} |
Authentication Context | user context optional |
Required OAuth Scopes | data:read |
Data Format | JSON |
Rate Limit | 60 calls per minute for force getting large resource.
300 calls per minute for requests that trigger metadata extraction. Does not apply to requests querying models whose metadata extraction is complete or in progress. |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via POST /authentication/v2/token |
Accept-Encoding string | A comma separated list of the algorithms you want the response to be encoded in, specified in the order of preference.
If you specify |
region enum: string | Specifies the data center where the manifest and derivative of the specified source design are stored in. Possible values are:
Note:
|
x-ads-force bool |
|
x-ads-derivative-format enum:string | Specifies what type of Object IDs to return, if the design has legacy SVF derivatives generated by the BIM Docs service. Possible values are:
Note
|
Request
URI Parameters
urn string | The URL safe Base64 encoded URN of the source design. |
modelGuid string | The ID of the Model View you are extracting metadata from. Use the List Model Views operation to get the IDs of the Model Views in the source design. |
Request
Query String Parameters
forceget string | true : Retrieves the object tree even if it exceeds the recommended maximum size (20 MB).false (Default) Does not retrieve the object tree if it exceeds the recommended maximum size (20 MB). |
objectid int | 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. |
level string | Specifies how many child levels of the hierarchy to return, when the objectid query string parameter is specified. Currently supports only level = 1 . |
Response
HTTP Status Code Summary
200 OK | Success. |
202 ACCEPTED | Request accepted but processing not complete. Call this endpoint iteratively until a 200 is returned. |
400 BAD REQUEST | The request is invalid. |
401 UNAUTHORIZED | Invalid authorization header. |
403 FORBIDDEN | Access denied regardless of authorization status. |
404 NOT FOUND | Endpoint does not exist or failed to extract the content. |
406 NOT ACCEPTABLE | The request is not supported. |
409 CONFLICT | The request conflicts with a previous request that is still in progress. |
413 REQUEST ENTITY TOO LARGE | The resource exceeded the expected maximum length (20 MB). |
429 TOO MANY REQUEST | Rate limit exceeded (60 requests per minute for force getting or 300 requests per minute for requests that trigger metadata extraction). Wait some time before retrying. |
500 INTERNAL SERVICE ERROR | Unexpected service interruption |
Response
HTTP Headers
x-ads-app-identifier string | The service identifier comprise service name, version and environment. |
x-ads-startup-time string | The service startup time with data format EEE MMM dd HH:mm:ss Z yyyy . |
x-ads-duration string | The request duration in milliseconds. |
x-ads-troubleshooting string | Provides information about the server failure. |
x-ads-size string | Size in bytes of the request data. It’s also for 413 resposne code. |
Response
Body Structure (200)
data object | Envelope that contains the returned data. |
type string | The type of data that is returned. Always objects . |
objects array:object | Collection of “objects”. |
objectid number | A non-persistent ID that is assigned to an object at translation time.
Note: The |
name string | Name of the object. |
objects array:object | Optional collection of objects within the hierarchy. |
Response
Body Structure (202)
result string | Request accepted but processing not complete. |
Example 1
This example demonstrates the successful retrieval of object hierarchy of a Revit model (200).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40'
Response
HTTP/1.1 200 OK
Date: Wed, 11 May 2022 07:25:25 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
x-ads-size: 34612
x-ads-duration: 555 ms
Content-Encoding: gzip
x-ads-startup-time: Wed May 11 01:50:08 UTC 2022
x-ads-app-identifier: platform-viewing-2022.05.01.73.1869d68d2-SNAPSHOT
Strict-Transport-Security: max-age=31536000; includeSubDomains
{
"data": {
"type": "objects",
"objects": [
{
"objectid": 1,
"objects": [
{
"objectid": 91,
"objects": [
{
"objectid": 4268,
"objects": [
{
"objectid": 4269,
"objects": [
{
"objectid": 169,
"name": "Floor [176804]"
},
{
"objectid": 590,
"name": "Floor [550255]"
}
],
"name": "Generic 150mm"
},
{
"objectid": 4270,
"objects": [
{
"objectid": 438,
"name": "Floor [418183]"
},
{
"objectid": 487,
"name": "Floor [549031]"
}
],
"name": "Generic 300"
},
{
"objectid": 4271,
"objects": [
{
"objectid": 201,
"name": "Floor [495352]"
}
],
"name": "Concrete-Domestic 425mm"
},
{
"objectid": 4272,
"objects": [
{
"objectid": 589,
"name": "Floor [512683]"
}
],
"name": "Timber Suspended Floor"
},
{
"objectid": 4273,
"objects": [
{
"objectid": 207,
"name": "Floor [647908]"
},
{
"objectid": 507,
"name": "Floor [764691]"
}
],
"name": "Insitu Concrete 225mm"
}
],
"name": "Floor"
}
],
"name": "Floors"
},
{
"objectid": 93,
"objects": [
{
"objectid": 4292,
"objects": [
{
"objectid": 4294,
"objects": [
{
"objectid": 436,
"name": "Basic Wall [198694]"
},
{
"objectid": 439,
"name": "Basic Wall [428588]"
},
{
"objectid": 440,
"name": "Basic Wall [428745]"
},
{
"objectid": 486,
"name": "Basic Wall [530178]"
}
],
"name": "SIP 202mm Wall - conc clad"
},
{
"objectid": 4295,
"objects": [
{
"objectid": 170,
"name": "Basic Wall [198749]"
},
{
"objectid": 437,
"name": "Basic Wall [234869]"
},
{
"objectid": 172,
"name": "Basic Wall [418079]"
},
{
"objectid": 175,
"name": "Basic Wall [422243]"
},
{
"objectid": 196,
"name": "Basic Wall [427092]"
},
{
"objectid": 432,
"name": "Basic Wall [655533]"
},
{
"objectid": 271,
"name": "Basic Wall [845266]"
},
{
"objectid": 274,
"name": "Basic Wall [849032]"
}
],
"name": "Wall - Timber Clad"
},
{
"objectid": 4296,
"objects": [
{
"objectid": 193,
"name": "Basic Wall [424922]"
},
{
"objectid": 195,
"name": "Basic Wall [425745]"
},
{
"objectid": 282,
"name": "Basic Wall [906885]"
}
],
"name": "Interior - 165 Partition (1-hr)"
},
{
"objectid": 4297,
"objects": [
{
"objectid": 442,
"name": "Basic Wall [429964]"
},
{
"objectid": 443,
"name": "Basic Wall [430064]"
},
{
"objectid": 444,
"name": "Basic Wall [430318]"
},
{
"objectid": 445,
"name": "Basic Wall [430361]"
},
{
"objectid": 446,
"name": "Basic Wall [430412]"
},
{
"objectid": 447,
"name": "Basic Wall [430859]"
},
{
"objectid": 478,
"name": "Basic Wall [497540]"
},
{
"objectid": 483,
"name": "Basic Wall [506386]"
},
{
"objectid": 484,
"name": "Basic Wall [506797]"
},
{
"objectid": 513,
"name": "Basic Wall [768442]"
},
{
"objectid": 556,
"name": "Basic Wall [937935]"
},
{
"objectid": 560,
"name": "Basic Wall [938974]"
},
{
"objectid": 561,
"name": "Basic Wall [939084]"
},
{
"objectid": 588,
"name": "Basic Wall [976752]"
}
],
"name": "Interior - Partition"
},
{
"objectid": 4298,
"objects": [
{
"objectid": 197,
"name": "Basic Wall [493612]"
},
{
"objectid": 198,
"name": "Basic Wall [493697]"
},
{
"objectid": 199,
"name": "Basic Wall [493790]"
},
{
"objectid": 204,
"name": "Basic Wall [627064]"
},
{
"objectid": 205,
"name": "Basic Wall [627729]"
},
{
"objectid": 206,
"name": "Basic Wall [628523]"
}
],
"name": "CL_W1"
},
{
"objectid": 4299,
"objects": [
{
"objectid": 200,
"name": "Basic Wall [493879]"
}
],
"name": "Foundation - 300mm Concrete"
},
{
"objectid": 4300,
"objects": [
{
"objectid": 490,
"name": "Basic Wall [599841]"
},
{
"objectid": 492,
"name": "Basic Wall [599951]"
},
{
"objectid": 502,
"name": "Basic Wall [745997]"
},
{
"objectid": 503,
"name": "Basic Wall [746235]"
},
{
"objectid": 504,
"name": "Basic Wall [746589]"
},
{
"objectid": 505,
"name": "Basic Wall [746634]"
},
{
"objectid": 506,
"name": "Basic Wall [746766]"
},
{
"objectid": 508,
"name": "Basic Wall [765523]"
},
{
"objectid": 509,
"name": "Basic Wall [765620]"
}
],
"name": "Retaining - 300mm Concrete"
},
{
"objectid": 4301,
"objects": [
{
"objectid": 321,
"name": "Basic Wall [977133]"
}
],
"name": "Cavity wall_sliders"
}
],
"name": "Basic Wall"
},
{
"objectid": 4293,
"objects": [
{
"objectid": 4739,
"objects": [
{
"objectid": 177,
"objects": [
{
"objectid": 178,
"name": "System Panel [423100]"
},
{
"objectid": 179,
"name": "Entrance door [423107]"
},
{
"objectid": 180,
"name": "Rectangular Mullion [423134]"
},
{
"objectid": 181,
"name": "Rectangular Mullion [423136]"
},
{
"objectid": 182,
"name": "Rectangular Mullion [423138]"
},
{
"objectid": 183,
"name": "Rectangular Mullion [423139]"
},
{
"objectid": 184,
"name": "Rectangular Mullion [423148]"
},
{
"objectid": 185,
"name": "Rectangular Mullion [423149]"
},
{
"objectid": 186,
"name": "System Panel [424758]"
},
{
"objectid": 187,
"name": "System Panel [424759]"
},
{
"objectid": 188,
"name": "Rectangular Mullion [424777]"
},
{
"objectid": 189,
"name": "Rectangular Mullion [424778]"
},
{
"objectid": 190,
"name": "Rectangular Mullion [424779]"
},
{
"objectid": 191,
"name": "Rectangular Mullion [424786]"
},
{
"objectid": 192,
"name": "Rectangular Mullion [424787]"
}
],
"name": "Curtain Wall [423099]"
},
{
"objectid": 441,
"objects": [
{
"objectid": 456,
"name": "Curtain Wall Dbl Glass [485452]"
},
{
"objectid": 457,
"name": "Rectangular Mullion [485456]"
},
{
"objectid": 458,
"name": "Rectangular Mullion [485458]"
},
{
"...Truncated for clarity":""
}
{
"objectid": 548,
"name": "Rectangular Mullion [931885]"
}
],
"name": "Curtain Wall [428797]"
},
{
"objectid": 593,
"objects": [
{
"objectid": 220,
"name": "Curtain Wall Dbl Glass [704276]"
},
{
"objectid": 221,
"name": "System Panel [704282]"
},
{
"...Truncated for clarity":""
}
{
"objectid": 616,
"name": "Rectangular Mullion [909759]"
}
],
"name": "Curtain Wall [704275]"
},
{
"objectid": 235,
"objects": [
{
"objectid": 236,
"name": "System Panel [707723]"
},
{
"objectid": 237,
"name": "Rectangular Mullion [707726]"
},
{
"objectid": 238,
"name": "Rectangular Mullion [707727]"
},
{
"objectid": 239,
"name": "Rectangular Mullion [707728]"
},
{
"objectid": 240,
"name": "Rectangular Mullion [707729]"
},
{
"objectid": 241,
"name": "System Panel [707847]"
},
{
"objectid": 242,
"name": "Rectangular Mullion [707857]"
},
{
"objectid": 243,
"name": "Rectangular Mullion [707859]"
},
{
"objectid": 244,
"name": "Rectangular Mullion [707861]"
}
],
"name": "Curtain Wall [707722]"
},
{
"objectid": 498,
"objects": [
{
"objectid": 245,
"name": "System Panel [708089]"
},
{
"objectid": 246,
"name": "Rectangular Mullion [708090]"
},
{
"objectid": 247,
"name": "Rectangular Mullion [708091]"
},
{
"objectid": 248,
"name": "Rectangular Mullion [708092]"
},
{
"objectid": 249,
"name": "Rectangular Mullion [708093]"
}
],
"name": "Curtain Wall [708088]"
},
{
"objectid": 499,
"objects": [
{
"objectid": 251,
"name": "Entrance door [709246]"
},
{
"objectid": 252,
"name": "Rectangular Mullion [709249]"
},
{
"objectid": 253,
"name": "Rectangular Mullion [709251]"
},
{
"objectid": 254,
"name": "Rectangular Mullion [709253]"
},
{
"objectid": 255,
"name": "System Panel [709256]"
},
{
"objectid": 256,
"name": "Rectangular Mullion [709258]"
},
{
"objectid": 257,
"name": "Rectangular Mullion [709259]"
},
{
"objectid": 258,
"name": "Rectangular Mullion [709261]"
}
],
"name": "Curtain Wall [709245]"
},
{
"objectid": 272,
"objects": [
{
"objectid": 322,
"name": "System Panel [977182]"
},
{
"objectid": 323,
"name": "System Panel [977191]"
},
{
"objectid": 324,
"name": "System Panel [977193]"
},
{
"...Truncated for clarity": ""
}
{
"objectid": 392,
"name": "Rectangular Mullion [977611]"
}
],
"name": "Curtain Wall [846939]"
},
{
"objectid": 273,
"objects": [
{
"objectid": 307,
"name": "Rectangular Mullion [976939]"
},
{
"objectid": 308,
"name": "Rectangular Mullion [976940]"
},
{
"objectid": 309,
"name": "System Panel [976942]"
},
{
"objectid": 310,
"name": "System Panel [976944]"
},
{
"objectid": 311,
"name": "System Panel [976946]"
},
{
"objectid": 313,
"name": "Rectangular Mullion [976954]"
},
{
"objectid": 314,
"name": "Rectangular Mullion [976955]"
},
{
"objectid": 315,
"name": "Rectangular Mullion [976956]"
},
{
"objectid": 316,
"name": "Rectangular Mullion [976957]"
},
{
"objectid": 317,
"name": "Rectangular Mullion [976958]"
},
{
"objectid": 318,
"name": "Rectangular Mullion [976959]"
},
{
"objectid": 319,
"name": "Rectangular Mullion [976960]"
},
{
"objectid": 320,
"name": "Rectangular Mullion [976961]"
},
{
"objectid": 371,
"name": "System Panel [977507]"
},
{
"objectid": 372,
"name": "Rectangular Mullion [977513]"
},
{
"objectid": 373,
"name": "Rectangular Mullion [977514]"
},
{
"objectid": 374,
"name": "Rectangular Mullion [977515]"
},
{
"objectid": 394,
"name": "Rectangular Mullion [978557]"
},
{
"objectid": 396,
"name": "Rectangular Mullion [978559]"
}
],
"name": "Curtain Wall [847436]"
},
{
"objectid": 337,
"objects": [
{
"objectid": 338,
"name": "System Panel [977406]"
},
{
"objectid": 339,
"name": "Rectangular Mullion [977408]"
},
{
"objectid": 340,
"name": "Rectangular Mullion [977409]"
},
{
"...Truncated for clarity": ""
}
{
"objectid": 370,
"name": "Rectangular Mullion [977453]"
}
],
"name": "Curtain Wall [977377]"
}
],
"name": "SH_Curtain wall"
}
],
"name": "Curtain Wall"
}
],
"name": "Walls"
},
{
"objectid": 94,
"objects": [
{
"objectid": 4304,
"objects": [
{
"objectid": 4310,
"objects": [
{
"objectid": 4312,
"name": "Sink-Offset-Kohler-Vault-3823_4 [211850]"
}
],
"name": "Steel-Stainless-NA"
}
],
"name": "Sink-Offset-Kohler-Vault-3823_4"
},
{
"objectid": 4305,
"objects": [
{
"objectid": 4313,
"objects": [
{
"objectid": 4315,
"name": "Faucet-8inch_Reach-Kohler-Purist-7507 [213811]"
}
],
"name": "Chrome-Polished_Chrome-CP"
}
],
"name": "Faucet-8inch_Reach-Kohler-Purist-7507"
},
{
"objectid": 4306,
"objects": [
{
"objectid": 4729,
"objects": [
{
"objectid": 4731,
"name": "Bathtub-TOTO-Nexus-FBF794S [420270]"
}
],
"name": "01 Cotton"
}
],
"name": "Bathtub-TOTO-Nexus-FBF794S"
},
{
"objectid": 4307,
"objects": [
{
"objectid": 5212,
"objects": [
{
"objectid": 496,
"name": "Lavatory-TOTO-Luminist_Rectangle_Vessel_LLT151 [698859]"
},
{
"objectid": 286,
"name": "Lavatory-TOTO-Luminist_Rectangle_Vessel_LLT151 [936823]"
},
{
"objectid": 555,
"name": "Lavatory-TOTO-Luminist_Rectangle_Vessel_LLT151 [937573]"
},
{
"objectid": 559,
"name": "Lavatory-TOTO-Luminist_Rectangle_Vessel_LLT151 [938763]"
}
],
"name": "Standard"
}
],
"name": "Lavatory-TOTO-Luminist_Rectangle_Vessel_LLT151"
},
{
"objectid": 4308,
"objects": [
{
"objectid": 5270,
"objects": [
{
"objectid": 514,
"name": "DC_Tankworks_PLM_5000L [778420]"
},
{
"objectid": 515,
"name": "DC_Tankworks_PLM_5000L [778575]"
}
],
"name": "5000L 3500x900x1860"
}
],
"name": "DC_Tankworks_PLM_5000L"
},
{
"objectid": 4309,
"objects": [
{
"objectid": 5311,
"objects": [
{
"objectid": 552,
"name": "M_Shower Stall-2D [937138]"
}
],
"name": "small"
},
{
"objectid": 5312,
"objects": [
{
"objectid": 554,
"name": "M_Shower Stall-2D [937572]"
},
{
"objectid": 558,
"name": "M_Shower Stall-2D [938762]"
}
],
"name": "M_Shower Stall-2D"
}
],
"name": "M_Shower Stall-2D"
}
],
"name": "Plumbing Fixtures"
},
{
"objectid": 95,
"objects": [
{
"objectid": 4322,
"objects": [
{
"objectid": 4323,
"objects": [
{
"objectid": 4326,
"name": "Basic Roof [243274]"
}
],
"name": "SG Metal Panels roof"
},
{
"objectid": 4324,
"objects": [
{
"objectid": 433,
"name": "Basic Roof [724430]"
}
],
"name": "Warm Roof - Timber"
}
],
"name": "Basic Roof"
}
],
"name": "Roofs"
},
{
"objectid": 99,
"objects": [
{
"objectid": 4429,
"name": "Surface [411452]"
},
{
"objectid": 4430,
"name": "Surface [490318]"
},
{
"objectid": 4431,
"name": "Surface [523063]"
}
],
"name": "Topography"
},
{
"objectid": 100,
"objects": [
{
"objectid": 4432,
"objects": [
{
"objectid": 4434,
"objects": [
{
"objectid": 171,
"name": "M_Concrete-Round-Column with Drop Caps [414482]"
}
],
"name": "M_1000"
}
],
"name": "M_Concrete-Round-Column with Drop Caps"
},
{
"objectid": 4433,
"objects": [
{
"objectid": 5234,
"objects": [
{
"objectid": 250,
"name": "M_L-Anglel-Column [708715]"
},
{
"objectid": 500,
"name": "M_L-Anglel-Column [709725]"
}
],
"name": "L127X127X9.5"
}
],
"name": "M_L-Anglel-Column"
}
],
"name": "Structural Columns"
},
{
"objectid": 104,
"objects": [
{
"objectid": 4726,
"objects": [
{
"objectid": 4727,
"objects": [
{
"objectid": 173,
"name": "M_Wind Power Generator [418977]"
},
{
"objectid": 174,
"name": "M_Wind Power Generator [418985]"
},
{
"objectid": 203,
"name": "M_Wind Power Generator [554644]"
}
],
"name": "9 Meters High"
}
],
"name": "M_Wind Power Generator"
}
],
"name": "Site"
},
{
"...Truncated for clarity": ""
}
{
"objectid": 161,
"objects": [
{
"objectid": 5407,
"objects": [
{
"objectid": 5410,
"objects": [
{
"objectid": 303,
"name": "M_RPC Beetle [950367]"
}
],
"name": "M_RPC Beetle"
}
],
"name": "M_RPC Beetle"
},
{
"objectid": 5408,
"objects": [
{
"objectid": 5412,
"objects": [
{
"objectid": 617,
"name": "RPC Female [954641]"
},
{
"objectid": 565,
"name": "RPC Female [954992]"
},
{
"objectid": 566,
"name": "RPC Female [955125]"
}
],
"name": "YinYin"
}
],
"name": "RPC Female"
},
{
"objectid": 5409,
"objects": [
{
"objectid": 5414,
"objects": [
{
"objectid": 435,
"name": "RPC Male [954779]"
}
],
"name": "Alex"
}
],
"name": "RPC Male"
}
],
"name": "Entourage"
}
],
"name": "Model"
}
]
}
}
Example 2
This example demonstrates the retrieval of the hierarchy of the same model view used in Example 1, but filtered for objectid
= 93
(200).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40?objectid=93'
Response
HTTP/1.1 200 OK
Date: Wed, 11 May 2022 07:27:55 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
x-ads-size: 34612
Cache-Control: private, max-age=3600
x-ads-duration: 1779 ms
Content-Encoding: gzip
x-ads-startup-time: Wed May 11 07:26:13 UTC 2022
x-ads-app-identifier: platform-viewing-2022.05.01.73.1869d68d2-SNAPSHOT-dev
Strict-Transport-Security: max-age=31536000; includeSubDomains
{
"data": {
"type": "objects",
"objects": [
{
"objectid": 93,
"objects": [
{
"objectid": 4292,
"objects": [
{
"objectid": 4294,
"objects": [
{
"objectid": 436,
"name": "Basic Wall [198694]"
},
{
"objectid": 439,
"name": "Basic Wall [428588]"
},
{
"objectid": 440,
"name": "Basic Wall [428745]"
},
{
"objectid": 486,
"name": "Basic Wall [530178]"
}
],
"name": "SIP 202mm Wall - conc clad"
},
{
"objectid": 4295,
"objects": [
{
"objectid": 170,
"name": "Basic Wall [198749]"
},
{
"objectid": 437,
"name": "Basic Wall [234869]"
},
{
"objectid": 172,
"name": "Basic Wall [418079]"
},
{
"objectid": 175,
"name": "Basic Wall [422243]"
},
{
"objectid": 196,
"name": "Basic Wall [427092]"
},
{
"objectid": 432,
"name": "Basic Wall [655533]"
},
{
"objectid": 271,
"name": "Basic Wall [845266]"
},
{
"objectid": 274,
"name": "Basic Wall [849032]"
}
],
"name": "Wall - Timber Clad"
},
{
"objectid": 4296,
"objects": [
{
"objectid": 193,
"name": "Basic Wall [424922]"
},
{
"objectid": 195,
"name": "Basic Wall [425745]"
},
{
"objectid": 282,
"name": "Basic Wall [906885]"
}
],
"name": "Interior - 165 Partition (1-hr)"
},
{
"objectid": 4297,
"objects": [
{
"objectid": 442,
"name": "Basic Wall [429964]"
},
{
"objectid": 443,
"name": "Basic Wall [430064]"
},
{
"objectid": 444,
"name": "Basic Wall [430318]"
},
{
"objectid": 445,
"name": "Basic Wall [430361]"
},
{
"objectid": 446,
"name": "Basic Wall [430412]"
},
{
"objectid": 447,
"name": "Basic Wall [430859]"
},
{
"objectid": 478,
"name": "Basic Wall [497540]"
},
{
"objectid": 483,
"name": "Basic Wall [506386]"
},
{
"objectid": 484,
"name": "Basic Wall [506797]"
},
{
"objectid": 513,
"name": "Basic Wall [768442]"
},
{
"objectid": 556,
"name": "Basic Wall [937935]"
},
{
"objectid": 560,
"name": "Basic Wall [938974]"
},
{
"objectid": 561,
"name": "Basic Wall [939084]"
},
{
"objectid": 588,
"name": "Basic Wall [976752]"
}
],
"name": "Interior - Partition"
},
{
"objectid": 4298,
"objects": [
{
"objectid": 197,
"name": "Basic Wall [493612]"
},
{
"objectid": 198,
"name": "Basic Wall [493697]"
},
{
"objectid": 199,
"name": "Basic Wall [493790]"
},
{
"objectid": 204,
"name": "Basic Wall [627064]"
},
{
"objectid": 205,
"name": "Basic Wall [627729]"
},
{
"objectid": 206,
"name": "Basic Wall [628523]"
}
],
"name": "CL_W1"
},
{
"objectid": 4299,
"objects": [
{
"objectid": 200,
"name": "Basic Wall [493879]"
}
],
"name": "Foundation - 300mm Concrete"
},
{
"objectid": 4300,
"objects": [
{
"objectid": 490,
"name": "Basic Wall [599841]"
},
{
"objectid": 492,
"name": "Basic Wall [599951]"
},
{
"objectid": 502,
"name": "Basic Wall [745997]"
},
{
"objectid": 503,
"name": "Basic Wall [746235]"
},
{
"objectid": 504,
"name": "Basic Wall [746589]"
},
{
"objectid": 505,
"name": "Basic Wall [746634]"
},
{
"objectid": 506,
"name": "Basic Wall [746766]"
},
{
"objectid": 508,
"name": "Basic Wall [765523]"
},
{
"objectid": 509,
"name": "Basic Wall [765620]"
}
],
"name": "Retaining - 300mm Concrete"
},
{
"objectid": 4301,
"objects": [
{
"objectid": 321,
"name": "Basic Wall [977133]"
}
],
"name": "Cavity wall_sliders"
}
],
"name": "Basic Wall"
},
{
"objectid": 4293,
"objects": [
{
"objectid": 4739,
"objects": [
{
"objectid": 177,
"objects": [
{
"objectid": 178,
"name": "System Panel [423100]"
},
{
"objectid": 179,
"name": "Entrance door [423107]"
},
{
"objectid": 180,
"name": "Rectangular Mullion [423134]"
},
{
"objectid": 181,
"name": "Rectangular Mullion [423136]"
},
{
"objectid": 182,
"name": "Rectangular Mullion [423138]"
},
{
"objectid": 183,
"name": "Rectangular Mullion [423139]"
},
{
"objectid": 184,
"name": "Rectangular Mullion [423148]"
},
{
"objectid": 185,
"name": "Rectangular Mullion [423149]"
},
{
"objectid": 186,
"name": "System Panel [424758]"
},
{
"objectid": 187,
"name": "System Panel [424759]"
},
{
"objectid": 188,
"name": "Rectangular Mullion [424777]"
},
{
"objectid": 189,
"name": "Rectangular Mullion [424778]"
},
{
"objectid": 190,
"name": "Rectangular Mullion [424779]"
},
{
"objectid": 191,
"name": "Rectangular Mullion [424786]"
},
{
"objectid": 192,
"name": "Rectangular Mullion [424787]"
}
],
"name": "Curtain Wall [423099]"
},
{
"objectid": 441,
"objects": [
{
"objectid": 456,
"name": "Curtain Wall Dbl Glass [485452]"
},
{
"objectid": 457,
"name": "Rectangular Mullion [485456]"
},
{
"objectid": 458,
"name": "Rectangular Mullion [485458]"
},
{
"objectid": 459,
"name": "System Panel [485460]"
},
{
"objectid": 460,
"name": "System Panel [485462]"
},
{
"objectid": 461,
"name": "System Panel [485464]"
},
{
"objectid": 462,
"name": "System Panel [485466]"
},
{
"objectid": 463,
"name": "System Panel [485467]"
},
{
"objectid": 464,
"name": "System Panel [485468]"
},
{
"objectid": 465,
"name": "System Panel [485469]"
},
{
"objectid": 466,
"name": "Rectangular Mullion [485492]"
},
{
"objectid": 467,
"name": "Rectangular Mullion [485493]"
},
{
"objectid": 468,
"name": "Rectangular Mullion [485494]"
},
{
"objectid": 469,
"name": "Rectangular Mullion [485500]"
},
{
"objectid": 470,
"name": "Rectangular Mullion [485501]"
},
{
"objectid": 471,
"name": "Rectangular Mullion [485505]"
},
{
"objectid": 472,
"name": "Rectangular Mullion [485506]"
},
{
"objectid": 473,
"name": "Rectangular Mullion [485507]"
},
{
"objectid": 474,
"name": "Rectangular Mullion [485508]"
},
{
"objectid": 475,
"name": "Rectangular Mullion [485509]"
},
{
"objectid": 485,
"name": "Rectangular Mullion [525603]"
},
{
"objectid": 493,
"name": "Rectangular Mullion [687033]"
},
{
"objectid": 494,
"name": "Rectangular Mullion [687035]"
},
{
"objectid": 495,
"name": "Rectangular Mullion [687037]"
},
{
"objectid": 501,
"name": "Rectangular Mullion [745035]"
},
{
"objectid": 516,
"name": "Rectangular Mullion [846332]"
},
{
"objectid": 517,
"name": "Rectangular Mullion [846333]"
},
{
"objectid": 518,
"name": "Rectangular Mullion [846334]"
},
{
"objectid": 519,
"name": "Rectangular Mullion [846335]"
},
{
"objectid": 520,
"name": "Rectangular Mullion [846351]"
},
{
"objectid": 536,
"name": "System Panel [931858]"
},
{
"objectid": 537,
"name": "System Panel [931859]"
},
{
"objectid": 538,
"name": "System Panel [931860]"
},
{
"objectid": 539,
"name": "System Panel [931861]"
},
{
"objectid": 540,
"name": "Rectangular Mullion [931877]"
},
{
"objectid": 541,
"name": "Rectangular Mullion [931878]"
},
{
"objectid": 542,
"name": "Rectangular Mullion [931879]"
},
{
"objectid": 543,
"name": "Rectangular Mullion [931880]"
},
{
"objectid": 544,
"name": "Rectangular Mullion [931881]"
},
{
"objectid": 545,
"name": "Rectangular Mullion [931882]"
},
{
"objectid": 546,
"name": "Rectangular Mullion [931883]"
},
{
"objectid": 547,
"name": "Rectangular Mullion [931884]"
},
{
"objectid": 548,
"name": "Rectangular Mullion [931885]"
}
],
"name": "Curtain Wall [428797]"
},
{
"objectid": 593,
"objects": [
{
"objectid": 220,
"name": "Curtain Wall Dbl Glass [704276]"
},
{
"objectid": 221,
"name": "System Panel [704282]"
},
{
"objectid": 222,
"name": "System Panel [704284]"
},
{
"objectid": 223,
"name": "Curtain Wall Dbl Glass [704286]"
},
{
"objectid": 224,
"name": "Rectangular Mullion [704288]"
},
{
"objectid": 225,
"name": "Rectangular Mullion [704289]"
},
{
"objectid": 226,
"name": "Rectangular Mullion [704290]"
},
{
"objectid": 227,
"name": "Rectangular Mullion [704291]"
},
{
"objectid": 228,
"name": "Rectangular Mullion [704293]"
},
{
"objectid": 229,
"name": "Rectangular Mullion [704294]"
},
{
"objectid": 230,
"name": "Rectangular Mullion [704296]"
},
{
"objectid": 231,
"name": "Rectangular Mullion [704297]"
},
{
"objectid": 232,
"name": "Rectangular Mullion [704298]"
},
{
"objectid": 233,
"name": "Rectangular Mullion [704299]"
},
{
"objectid": 234,
"name": "Rectangular Mullion [704300]"
},
{
"objectid": 604,
"name": "System Panel [909735]"
},
{
"objectid": 605,
"name": "System Panel [909736]"
},
{
"objectid": 606,
"name": "System Panel [909737]"
},
{
"objectid": 607,
"name": "System Panel [909738]"
},
{
"objectid": 608,
"name": "Rectangular Mullion [909751]"
},
{
"objectid": 609,
"name": "Rectangular Mullion [909752]"
},
{
"objectid": 610,
"name": "Rectangular Mullion [909753]"
},
{
"objectid": 611,
"name": "Rectangular Mullion [909754]"
},
{
"objectid": 612,
"name": "Rectangular Mullion [909755]"
},
{
"objectid": 613,
"name": "Rectangular Mullion [909756]"
},
{
"objectid": 614,
"name": "Rectangular Mullion [909757]"
},
{
"objectid": 615,
"name": "Rectangular Mullion [909758]"
},
{
"objectid": 616,
"name": "Rectangular Mullion [909759]"
}
],
"name": "Curtain Wall [704275]"
},
{
"objectid": 235,
"objects": [
{
"objectid": 236,
"name": "System Panel [707723]"
},
{
"objectid": 237,
"name": "Rectangular Mullion [707726]"
},
{
"objectid": 238,
"name": "Rectangular Mullion [707727]"
},
{
"objectid": 239,
"name": "Rectangular Mullion [707728]"
},
{
"objectid": 240,
"name": "Rectangular Mullion [707729]"
},
{
"objectid": 241,
"name": "System Panel [707847]"
},
{
"objectid": 242,
"name": "Rectangular Mullion [707857]"
},
{
"objectid": 243,
"name": "Rectangular Mullion [707859]"
},
{
"objectid": 244,
"name": "Rectangular Mullion [707861]"
}
],
"name": "Curtain Wall [707722]"
},
{
"objectid": 498,
"objects": [
{
"objectid": 245,
"name": "System Panel [708089]"
},
{
"objectid": 246,
"name": "Rectangular Mullion [708090]"
},
{
"objectid": 247,
"name": "Rectangular Mullion [708091]"
},
{
"objectid": 248,
"name": "Rectangular Mullion [708092]"
},
{
"objectid": 249,
"name": "Rectangular Mullion [708093]"
}
],
"name": "Curtain Wall [708088]"
},
{
"objectid": 499,
"objects": [
{
"objectid": 251,
"name": "Entrance door [709246]"
},
{
"objectid": 252,
"name": "Rectangular Mullion [709249]"
},
{
"objectid": 253,
"name": "Rectangular Mullion [709251]"
},
{
"objectid": 254,
"name": "Rectangular Mullion [709253]"
},
{
"objectid": 255,
"name": "System Panel [709256]"
},
{
"objectid": 256,
"name": "Rectangular Mullion [709258]"
},
{
"objectid": 257,
"name": "Rectangular Mullion [709259]"
},
{
"objectid": 258,
"name": "Rectangular Mullion [709261]"
}
],
"name": "Curtain Wall [709245]"
},
{
"objectid": 272,
"objects": [
{
"objectid": 322,
"name": "System Panel [977182]"
},
{
"objectid": 323,
"name": "System Panel [977191]"
},
{
"objectid": 324,
"name": "System Panel [977193]"
},
{
"objectid": 325,
"name": "System Panel [977195]"
},
{
"objectid": 326,
"name": "System Panel [977197]"
},
{
"objectid": 327,
"name": "System Panel [977199]"
},
{
"objectid": 328,
"name": "System Panel [977201]"
},
{
"objectid": 329,
"name": "System Panel [977203]"
},
{
"objectid": 330,
"name": "Rectangular Mullion [977247]"
},
{
"objectid": 331,
"name": "Rectangular Mullion [977248]"
},
{
"objectid": 332,
"name": "Rectangular Mullion [977249]"
},
{
"objectid": 333,
"name": "Rectangular Mullion [977250]"
},
{
"objectid": 334,
"name": "Rectangular Mullion [977251]"
},
{
"objectid": 335,
"name": "Rectangular Mullion [977252]"
},
{
"objectid": 336,
"name": "Rectangular Mullion [977253]"
},
{
"objectid": 375,
"name": "Rectangular Mullion [977594]"
},
{
"objectid": 376,
"name": "Rectangular Mullion [977595]"
},
{
"objectid": 377,
"name": "Rectangular Mullion [977596]"
},
{
"objectid": 378,
"name": "Rectangular Mullion [977597]"
},
{
"objectid": 379,
"name": "Rectangular Mullion [977598]"
},
{
"objectid": 380,
"name": "Rectangular Mullion [977599]"
},
{
"objectid": 381,
"name": "Rectangular Mullion [977600]"
},
{
"objectid": 382,
"name": "Rectangular Mullion [977601]"
},
{
"objectid": 383,
"name": "Rectangular Mullion [977602]"
},
{
"objectid": 384,
"name": "Rectangular Mullion [977603]"
},
{
"objectid": 385,
"name": "Rectangular Mullion [977604]"
},
{
"objectid": 386,
"name": "Rectangular Mullion [977605]"
},
{
"objectid": 387,
"name": "Rectangular Mullion [977606]"
},
{
"objectid": 388,
"name": "Rectangular Mullion [977607]"
},
{
"objectid": 389,
"name": "Rectangular Mullion [977608]"
},
{
"objectid": 390,
"name": "Rectangular Mullion [977609]"
},
{
"objectid": 391,
"name": "Rectangular Mullion [977610]"
},
{
"objectid": 392,
"name": "Rectangular Mullion [977611]"
}
],
"name": "Curtain Wall [846939]"
},
{
"objectid": 273,
"objects": [
{
"objectid": 307,
"name": "Rectangular Mullion [976939]"
},
{
"objectid": 308,
"name": "Rectangular Mullion [976940]"
},
{
"objectid": 309,
"name": "System Panel [976942]"
},
{
"objectid": 310,
"name": "System Panel [976944]"
},
{
"objectid": 311,
"name": "System Panel [976946]"
},
{
"objectid": 313,
"name": "Rectangular Mullion [976954]"
},
{
"objectid": 314,
"name": "Rectangular Mullion [976955]"
},
{
"objectid": 315,
"name": "Rectangular Mullion [976956]"
},
{
"objectid": 316,
"name": "Rectangular Mullion [976957]"
},
{
"objectid": 317,
"name": "Rectangular Mullion [976958]"
},
{
"objectid": 318,
"name": "Rectangular Mullion [976959]"
},
{
"objectid": 319,
"name": "Rectangular Mullion [976960]"
},
{
"objectid": 320,
"name": "Rectangular Mullion [976961]"
},
{
"objectid": 371,
"name": "System Panel [977507]"
},
{
"objectid": 372,
"name": "Rectangular Mullion [977513]"
},
{
"objectid": 373,
"name": "Rectangular Mullion [977514]"
},
{
"objectid": 374,
"name": "Rectangular Mullion [977515]"
},
{
"objectid": 394,
"name": "Rectangular Mullion [978557]"
},
{
"objectid": 396,
"name": "Rectangular Mullion [978559]"
}
],
"name": "Curtain Wall [847436]"
},
{
"objectid": 337,
"objects": [
{
"objectid": 338,
"name": "System Panel [977406]"
},
{
"objectid": 339,
"name": "Rectangular Mullion [977408]"
},
{
"objectid": 340,
"name": "Rectangular Mullion [977409]"
},
{
"...Truncated for clarity": ""
}
{
"objectid": 370,
"name": "Rectangular Mullion [977453]"
}
],
"name": "Curtain Wall [977377]"
}
],
"name": "SH_Curtain wall"
}
],
"name": "Curtain Wall"
}
],
"name": "Walls"
}
]
}
}
Example 3
This example demonstrates the retrieval of the hierarchy of the same model view and filter used in Example 2, but level
is set to 1 (200).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40?objectid=93&level=1'
Response
HTTP/1.1 200 OK
Date: Wed, 11 May 2022 07:41:58 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding
x-ads-duration: 691 ms
Content-Encoding: gzip
x-ads-startup-time: Wed May 11 07:26:13 UTC 2022
x-ads-app-identifier: platform-viewing-2022.05.01.73.1869d68d2-SNAPSHOT-dev
Strict-Transport-Security: max-age=31536000; includeSubDomains
[
{
"objectid": 4292,
"name": "Basic Wall",
"hasSubtree": true
},
{
"objectid": 4293,
"name": "Curtain Wall",
"hasSubtree": true
}
]
Example 4
This example demonstrates the failed attempt to retrieve large object hierarchy (413).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/c213b30e-73be-4060-ad9d-06f043192d9f'
Response
Status Code: 413 Request Entity Too Large
date: Fri, 03 Aug 2018 08:13:04 GMT
x-ads-app-identifier=platform-viewing-2018.06.02.63.f1ad853-production
x-ads-startup-time: Fri Aug 03 05:34:31 UTC 2018
x-ads-duration: 81 ms
x-ads-size: 26825314
{
"diagnostic": "Please use the 'forceget' parameter to force querying the data."
}
Example 5
This example demonstrates the successful retrieval of object hierarchy with forceget option (200).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/c213b30e-73be-4060-ad9d-06f043192d9f?forceget=true'
Response
Status Code: 200 OK
date: Fri, 03 Aug 2018 08:13:04 GMT
x-ads-app-identifier=platform-viewing-2018.06.02.63.f1ad853-production
x-ads-startup-time: Fri Aug 03 05:34:31 UTC 2018
x-ads-duration: 81 ms
x-ads-size: 26825314
{
"data": {
"type": "objects",
"objects": [
...
]
}
}
Example 6
This example demonstrates a failed attempt to retrieve the object hierarchy. This typically happens with very large models when the request times out.
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/c213b30e-73be-4060-ad9d-06f043192d9f'
Response
Status Code: 404 Not Found
date: Fri, 03 Aug 2018 08:13:04 GMT
x-ads-app-identifier=platform-viewing-2018.06.02.63.f1ad853-production
x-ads-startup-time: Fri Aug 03 05:34:31 UTC 2018
x-ads-duration: 81 ms
x-ads-size: 26825314
{
"diagnostic": "Failed to query the data."
}
Example 7
This example demonstrates the successful retrieval of object hierarchy with the x-ads-force
option, which retries on recoverable failures (200).
Request
curl -X 'GET' \
-H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL' \
-H 'x-ads-force: true' \
-v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxkZXJpdmF0aXZlL0E1LnppcA/metadata/c213b30e-73be-4060-ad9d-06f043192d9f'
Response
Status Code: 200 OK
Last-Modified: Fri. 13 May 2016 08:49:06 GMT
x-ads-app-identifier=platform-viewing-2016.05.03.1102.2f6bfbf-production
x-ads-startup-time: Fri May 13 08:49:06 UTC 2016
x-ads-duration: 3 ms
{
"data": {
"type": "objects",
"objects": [
{
"objectid": 1,
"name": "A5",
"objects": [
{
"objectid": 2,
"name": "Model",
"objects": [
{
"objectid": 3,
"name": "Bottom",
"objects": [
{
"objectid": 4,
"name": "Box"
}
]
},
{
"objectid": 5,
"name": "Pillar",
"objects": [
{
"objectid": 6,
"name": "Cylinder"
}
]
},
{
"objectid": 7,
"name": "Top",
"objects": [
{
"objectid": 8,
"name": "Box"
}
]
}
]
}
]
}
]
}
}