> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Cognite Data Fusion (CDF) is an industrial DataOps platform. Prefer English docs unless the user asks for another locale.
> Follow /_llms/ index links recursively until you reach page URLs ending in .md. Fetch those Markdown twins instead of HTML.
> For REST APIs, default to calendar version 20230101 (stable). Use 20230101-beta or 20230101-alpha only if the user is on a preview API. Cite paths under /api-reference/concepts/<version>/ and the Cdf-Version header. Prefer the Python SDK (cognite-sdk) unless the user is in JavaScript/TypeScript.
> Start here by task: platform overview /cdf/index.md; data modeling /cdf/dm/index.md; data integration /cdf/integration/index.md; access /cdf/access/index.md; CDF Toolkit /cdf/deploy/cdf_toolkit/index.md; REST quickstart /dev/quickstart.md; Python SDK https://cognite-sdk-python.readthedocs-hosted.com/en/stable/; Atlas AI /cdf/atlas_ai/concepts/index.md; Flows apps /cdf/flows/index.md; MCP and IDE setup /dev/guides/ide_ai_integration.md.
> For implementation work, also load /skill.md.

# Filter 3D asset mappings

> Lists mappings for one filter. Not available in data modeling only projects. Requires `threedAcl:READ`. See [Mapping rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).



## OpenAPI

````yaml https://storage.googleapis.com/cognitedata-api-docs/dist/20230101-beta.json post /3d/models/{modelId}/revisions/{revisionId}/mappings/list
openapi: 3.1.0
info:
  title: Cognite API
  description: >-
    Reference documentation for the Cognite Data Fusion (CDF) API. See the [API
    introduction](/api-reference/concepts/20230101/api-description) and [API
    changelog](/api-reference/changelog).
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
  - url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
    description: The URL for the CDF cluster to connect to
    variables:
      cluster:
        enum:
          - api
          - az-tyo-gp-001
          - az-eastus-1
          - az-power-no-northeurope
          - westeurope-1
          - asia-northeast1-1
          - gc-dsm-gp-001
        default: api
        description: The CDF cluster to connect to
      project:
        default: publicdata
        description: The CDF project name.
security:
  - oidc-token:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-client-credentials:
      - https://{cluster}.cognitedata.com/.default
  - oauth2-open-industrial-data:
      - https://api.cognitedata.com/.default
  - oauth2-auth-code:
      - https://{cluster}.cognitedata.com/.default
tags:
  - name: Token
  - name: Assets
  - name: Data Modeling
    x-uri-format-fragments: []
  - name: Streams
  - name: Records
  - name: Events
  - name: Files
  - name: Functions
  - name: Function calls
  - name: Function schedules
  - name: Function Apps
  - name: Function App Calls
  - name: Function App MCP
  - name: 3D
  - name: Time series
  - name: Data point subscriptions
  - name: Synthetic Time Series
  - name: Raw
    x-uri-format-fragments: []
  - name: Groups
  - name: Projects
  - name: Security categories
  - name: Data sets
  - name: Sequences
  - name: Labels
  - name: Relationships
  - name: Entity matching
  - name: Entity matching pipelines
  - name: Diagram parsing
  - name: Vision
  - name: Agents
  - name: Skills
  - name: Project Configuration
  - name: Models
  - name: Cognite AI
  - name: Documents
  - name: Document preview
    x-displayName: Preview
  - name: Geospatial
  - name: SessionsInternal
  - name: Sessions
  - name: Extraction Pipelines
  - name: Extraction Pipelines Runs
  - name: Extraction Pipelines Config
  - name: Extractors
  - name: Transformations
  - name: Transformation Jobs
  - name: Transformation Schedules
  - name: Transformation Notifications
  - name: Query
  - name: Schema
  - name: Transformation External Data Sources
  - name: Annotations
  - name: User profiles
  - name: Workflows
  - name: Workflow versions
  - name: Workflow executions
  - name: Tasks
  - name: Workflow triggers
  - name: Sources
  - name: Jobs
  - name: Destinations
  - name: Mappings
  - name: Previews
  - name: Postgres Gateway Users
  - name: Postgres Gateway Tables
  - name: SAP Instances
  - name: SAP Endpoints
  - name: Schema Mappings
  - name: Writeback Requests
  - name: Simulators
  - name: Simulator Integrations
  - name: Simulator Routines
  - name: Simulator Models
  - name: Simulation Runs
  - name: Simulator Logs
  - name: Units
  - name: Unit Systems
  - name: Application Data Storage
  - name: Location Filters
  - name: User Preferences
  - name: User History
  - name: Search Config
  - name: Organizations
  - name: Applications
  - name: Integrations
  - name: Integration Tasks
  - name: Integration Actions
  - name: Integration Configuration
  - name: Integration Errors
  - name: Principals
  - name: Signals
  - name: Data products
paths:
  /3d/models/{modelId}/revisions/{revisionId}/mappings/list:
    post:
      tags:
        - 3D Asset Mapping
      summary: Filter 3D asset mappings
      description: >-
        Lists mappings for one filter. Not available in data modeling only
        projects. Requires `threedAcl:READ`. See [Mapping
        rules](/api-reference/concepts/20230101/3d-asset-mapping#mapping-rules).
      operationId: filter3DAssetMappings
      parameters:
        - $ref: '#/components/parameters/ModelId'
        - $ref: '#/components/parameters/RevisionId'
      requestBody:
        description: The filter for asset mappings to get.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetMapping3DFilterRequest'
      responses:
        '200':
          description: A list of matching asset mappings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetMapping3DWithCursorResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
      deprecated: true
      x-code-samples:
        - lang: JavaScript
          label: JavaScript SDK
          source: >-
            const mappings3D = await
            client.assetMappings3D.filter(3244265346345, 32423454353545, {
              filter: {
                treeIndexes: [1000, 1001, 1002]
              }
            });
        - lang: Java
          label: Java SDK
          source: |2+
             Request request1 = 
                      Request.create().withFilterParameter("assetIds", List.of(1L, 2L)); 
            Iterator<List<ThreeDAssetMapping>> itFilter1 = client.threeD() 
                      .models() 
                      .revisions() 
                      .assetMappings() 
                      .filter(model.getId(), revision.getId(), request1); 

components:
  parameters:
    ModelId:
      name: modelId
      in: path
      description: Model ID.
      required: true
      schema:
        type: integer
        format: int64
    RevisionId:
      name: revisionId
      in: path
      description: Revision ID.
      required: true
      schema:
        type: integer
        format: int64
  schemas:
    AssetMapping3DFilterRequest:
      allOf:
        - $ref: '#/components/schemas/AssetMapping3DFilter'
        - $ref: '#/components/schemas/Cursor'
    AssetMapping3DWithCursorResponse:
      allOf:
        - $ref: '#/components/schemas/AssetMapping3DList'
        - $ref: '#/components/schemas/NextCursorData'
    AssetMapping3DFilter:
      type: object
      properties:
        getDmsInstances:
          type: boolean
          description: >-
            If true, the response will include only the mappings with
            assetInstanceId values, for DMS based assets.
          default: false
        filter:
          oneOf:
            - $ref: '#/components/schemas/AssetMapping3DAssetFilter'
            - $ref: '#/components/schemas/AssetMapping3DAssetInstanceIdFilter'
            - $ref: '#/components/schemas/AssetMapping3DNodeFilter'
            - $ref: '#/components/schemas/AssetMapping3DTreeIndexFilter'
        limit:
          description: Limits the number of results to return.
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          default: 100
    Cursor:
      type: object
      properties:
        cursor:
          type: string
          example: 4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
      description: >
        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.
    AssetMapping3DList:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AssetMapping3D'
    NextCursorData:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/NextCursor'
    Error:
      type: object
      required:
        - code
        - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
    AssetMapping3DAssetFilter:
      type: object
      required:
        - assetIds
      properties:
        assetIds:
          type: array
          minItems: 0
          maxItems: 100
          items:
            type: integer
            format: int64
    AssetMapping3DAssetInstanceIdFilter:
      type: object
      required:
        - assetInstanceIds
      properties:
        assetInstanceIds:
          type: array
          minItems: 0
          maxItems: 100
          items:
            $ref: '#/components/schemas/CogniteInstanceId'
    AssetMapping3DNodeFilter:
      type: object
      required:
        - nodeIds
      properties:
        nodeIds:
          type: array
          minItems: 0
          maxItems: 100
          items:
            type: integer
            format: int64
    AssetMapping3DTreeIndexFilter:
      type: object
      required:
        - treeIndexes
      properties:
        treeIndexes:
          type: array
          minItems: 0
          maxItems: 100
          items:
            $ref: '#/components/schemas/TreeIndex'
    AssetMapping3D:
      type: object
      required:
        - nodeId
      properties:
        nodeId:
          type: integer
          description: The ID of the node.
          format: int64
          example: 1003
        assetId:
          type: integer
          description: The ID of the associated asset (Cognite's Assets API).
          format: int64
          example: 3001
        assetInstanceId:
          $ref: '#/components/schemas/DirectRelationReference'
        treeIndex:
          $ref: '#/components/schemas/TreeIndex'
        subtreeSize:
          $ref: '#/components/schemas/SubtreeSize'
    NextCursor:
      type: string
      description: Cursor to get the next page of results (if available).
    CogniteInstanceId:
      description: >-
        The ID of an [instance in Cognite Data
        Models](https://docs.cognite.com/cdf/dm/dm_concepts/dm_spaces_instances#instance).
      type: object
      required:
        - space
        - externalId
      properties:
        space:
          $ref: '#/components/schemas/Space'
        externalId:
          $ref: '#/components/schemas/InstanceExternalId'
    TreeIndex:
      type: integer
      minimum: 0
      description: >-
        The index of the node in the 3D model hierarchy, starting from 0. The
        tree is traversed in a depth-first order.
      format: int64
      example: 3
    DirectRelationReference:
      type: object
      description: >-
        Reference to the node pointed to by the direct relation. The reference
        consists of a space and an external-id.
      required:
        - space
        - externalId
      properties:
        space:
          $ref: '#/components/schemas/SpaceSpecification'
        externalId:
          $ref: '#/components/schemas/NodeOrEdgeExternalId'
    SubtreeSize:
      type: integer
      description: The number of descendants of the node, plus one (counting itself).
      format: int64
      example: 4
    Space:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
      minLength: 1
      maxLength: 43
    InstanceExternalId:
      type: string
      pattern: ^[a-zA-Z]([a-zA-Z0-9_]{0,253}[a-zA-Z0-9])?$
      minLength: 1
      maxLength: 255
    SpaceSpecification:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
      minLength: 1
      maxLength: 43
    NodeOrEdgeExternalId:
      type: string
      pattern: ^[^\\x00]{1,256}$
      minLength: 1
      maxLength: 256
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: >-
        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.
    oauth2-client-credentials:
      type: oauth2
      description: >-
        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.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: >-
        Auth flow for Open Industrial Data. Get your client secret from
        https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: >-
            https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: >-
        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.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default

````