Filter 3D asset mappings

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.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
modelId
required
integer <int64>

Model ID.

revisionId
required
integer <int64>

Revision ID.

Request Body schema: application/json

The filter for asset mappings to get.

getDmsInstances
boolean
Default: false

If true, the response will include only the mappings with assetInstanceId values, for DMS based assets.

AssetMapping3DAssetFilter (object) or AssetMapping3DAssetInstanceIdFilter (object) or AssetMapping3DNodeFilter (object) or AssetMapping3DTreeIndexFilter (object)
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limits the number of results to return.

cursor
string
Responses
200

A list of matching asset mappings.

400

The response for a failed request.

post/3d/models/{modelId}/revisions/{revisionId}/mappings/list
Request samples
application/json
{
  • "getDmsInstances": false,
  • "filter": {
    • "assetIds": [
      ]
    },
  • "limit": 100,
  • "cursor": "4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Filter 3D assetInstanceId mappings across all 3D models