const mappings3D = await client.assetMappings3D.list(3244265346345, 32423454353545);{
"items": [
{
"nodeId": 1003,
"assetId": 3001,
"assetInstanceId": {
"space": "<string>",
"externalId": "<string>"
},
"treeIndex": 3,
"subtreeSize": 4
}
],
"nextCursor": "<string>"
}List 3D asset mappings
Required capabilities:
threedAcl:READ
Lists 3D assets mappings that match the ID for the specified filter query parameter type. Only one type of filter can be specified for each request, either assetId, nodeId or intersectsBoundingBox.
In Hybrid CDF projects: The nodeId and assetId mappings are returned by default.
To instead see any assetInstanceId mappings (for CoreDM based contextualization),
set the getDmsInstances query parameter to true.
In DataModelingOnly CDF projects: This endpoint is not available. Use DMS queries to list CogniteCADNodes.
Note: When filtering for a specific nodeId, only nodeIds that actually exists will be returned. When filtering for a specific assetId, all mappings will be returned, even if the assetId does not exist.
const mappings3D = await client.assetMappings3D.list(3244265346345, 32423454353545);{
"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.
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 <= 1000Example: {"min":[0.0, 0.0, 0.0], "max":[1.0, 1.0, 1.0]}
If given, only return asset mappings for assets whose bounding box intersects the given bounding box.
Must be a JSON object with min, max arrays of coordinates.
If true, the response will include any assetInstanceId instances for the mappings.
Was this page helpful?