API reference (20230101-alpha)
const nodes3d = await client.revisions3D.list3DNodeAncestors(8252999965991682, 4190022127342195, 572413075141081);{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"parentId": 2,
"properties": {
"category1": {
"property1": "value1",
"property2": "value2"
},
"category2": {
"property1": "value1",
"property2": "value2"
}
},
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
],
"nextCursor": "<string>"
}List 3D ancestor nodes
Required capabilities:
threedAcl:READ
Retrieves a list of ancestor nodes of a given node, including itself, in the hierarchy of the 3D model. This operation supports pagination. Will return error 400 if the revision is still being processed.
const nodes3d = await client.revisions3D.list3DNodeAncestors(8252999965991682, 4190022127342195, 572413075141081);{
"items": [
{
"id": 1000,
"treeIndex": 3,
"depth": 2,
"name": "Node name",
"subtreeSize": 4,
"parentId": 2,
"properties": {
"category1": {
"property1": "value1",
"property2": "value2"
},
"category2": {
"property1": "value1",
"property2": "value2"
}
},
"boundingBox": {
"max": [
123
],
"min": [
123
]
}
}
],
"nextCursor": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
Model ID.
Revision ID.
ID of the node to get the ancestors of.
Query Parameters
Cursor for paging through results. In general, if a response contains a nextCursor
property, it means that there may be more results, and you should pass that value as the
cursor parameter in the next request.
Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.
1 <= x <= 1000Was this page helpful?