API reference (20230101-alpha)
const query = {
filter: {
properties: {
Items: {
Type: ["Cylinder"]
}
}
},
partition: "1/10"
};
const nodes3d = await client.revisions3D.filter3DNodes(8252999965991682, 4190022127342195, query);{
"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>"
}Filter 3D nodes
Required capabilities:
threedAcl:READ
List nodes in a project, filtered by node names or node property values specified by supplied filters. This operation supports pagination and partitions. If the model revision is still being processed, you will get a HTTP status 400 when accessing nodes too early. Wait until the retrieve revision response returns “status”:“Done” before calling nodes endpoints.
const query = {
filter: {
properties: {
Items: {
Type: ["Cylinder"]
}
}
},
partition: "1/10"
};
const nodes3d = await client.revisions3D.filter3DNodes(8252999965991682, 4190022127342195, query);{
"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.
Body
- Option 1
- Option 2
Filter request for nodes. Filters nodes with properties matching ones in a list of alternatives.
Filters used in the search.
Show child attributes
Show child attributes
Limits the number of results to return.
1 <= x <= 1000"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Splits the data set into N partitions.
The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N].
You need to follow the cursors within each partition in order to receive all the data.
To prevent unexpected problems and maximize read throughput, you should at most use 10 (N <= 10) partitions.
When using more than 10 partitions, CDF may reduce the number of partitions silently.
For example, CDF may reduce the number of partitions to K = 10 so if you specify an X/N partition value where X = 8 and N = 20 - i.e. "partition": "8/20"- then
CDF will change N to N = K = 10 and process the request.
But if you specify the X/N partition value where X = 11 (X > K) and N = 20 - i.e. "partition": "11/20"- then
CDF will reply with an empty result list and no cursor in the response.\
In future releases of the resource APIs, Cognite may reject requests if you specify more than 10 partitions. When Cognite enforces this behavior, the requests will result in a 400 Bad Request status.
"1/10"
Was this page helpful?