const mappings3D = await client.assetMappings3D.filter(3244265346345, 32423454353545, {
filter: {
treeIndexes: [1000, 1001, 1002]
}
});{
"items": [
{
"nodeId": 1003,
"assetId": 3001,
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"treeIndex": 3,
"subtreeSize": 4
}
],
"nextCursor": "<string>"
}Filter 3D asset mappings
Required capabilities:
threedAcl:READ
Lists 3D assets mappings that match the specified filter parameter.
Only one type of filter can be specified for each request, either assetIds, nodeIds or treeIndexes.
In Hybrid CDF projects: The nodeId and assetId mappings are returned by default.
To instead see only any assetInstanceId mappings (for CoreDM based contextualization),
set the getDmsInstances property to true, in the request body.
In DataModelingOnly CDF projects: This endpoint is not available. Use DMS queries to list CogniteCADNodes.
const mappings3D = await client.assetMappings3D.filter(3244265346345, 32423454353545, {
filter: {
treeIndexes: [1000, 1001, 1002]
}
});{
"items": [
{
"nodeId": 1003,
"assetId": 3001,
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"treeIndex": 3,
"subtreeSize": 4
}
],
"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
The filter for asset mappings to get.
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.
If true, the response will include only the mappings with assetInstanceId values, for DMS based assets.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Limits the number of results to return.
1 <= x <= 1000"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Was this page helpful?