Cognite Mappings API

openapi: 3.2.0
info:
  title: Cognite Mappings API
  description: '# Introduction

    This is the reference documentation for the Cognite API with

    an overview of all the available methods.'
  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: Mappings
  description: A **mapping** is a custom transformation, translating the source format to a format that can be ingested into CDF. Mappings are written in the Cognite transformation language. For more details see documentation here.
paths:
  /hostedextractors/mappings:
    get:
      tags:
      - Mappings
      operationId: list_mappings
      x-capability:
      - hostedExtractors:READ
      description: '> **Required capabilities:** `hostedExtractors:READ`


        List all mappings in a given project. If more than `limit` mappings exist, a cursor for pagination will be returned with the response.'
      parameters:
      - $ref: '#/components/parameters/100Limit'
      - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsWithCursor_Mapping_'
          description: List of mappings and an optional cursor.
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      summary: List Mappings
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: "mapping_list = client.hosted_extractors.mappings.list(limit=5)\n\nfor mapping in client.hosted_extractors.mappings:\n    mapping # do something with the mapping\n\nfor mapping_list in client.hosted_extractors.mappings(chunk_size=25):\n    mapping_list # do something with the mappings\n"
    post:
      tags:
      - Mappings
      operationId: create_mappings
      x-capability:
      - hostedExtractors:WRITE
      description: '> **Required capabilities:** `hostedExtractors:WRITE`


        Create up to 100 mappings.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Items_CreateMapping_'
        required: true
        description: Mappings to create.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Items_Mapping_'
          description: List of created mappings
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      summary: Create Mappings
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'from cognite.client.data_classes.hosted_extractors import MappingWrite, CustomMapping

          mapping = MappingWrite(external_id="my_mapping", mapping=CustomMapping("some expression"), published=True, input="json")

          res = client.hosted_extractors.mappings.create(mapping)

          '
  /hostedextractors/mappings/byIds:
    post:
      operationId: retrieve_mappings
      x-capability:
      - hostedExtractors:READ
      tags:
      - Mappings
      description: '> **Required capabilities:** `hostedExtractors:READ`


        Retrieve a list of up to 100 mappings by their external ID, optionally ignoring unknown IDs.'
      parameters:
      - in: header
        name: cdf-version
        required: false
        schema:
          title: Cdf-Version
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemsWithIgnoreUnknownIds_ExternalId_'
        required: true
        description: List of external IDs of mappings to retrieve.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Items_Mapping_'
          description: List of retrieved mappings.
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      summary: Retrieve Mappings
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'res = client.hosted_extractors.mappings.retrieve(''myMapping'')


          res = client.hosted_extractors.mappings.retrieve(["myMapping", "myMapping2"], ignore_unknown_ids=True)

          '
  /hostedextractors/mappings/delete:
    post:
      operationId: delete_mappings
      x-capability:
      - hostedExtractors:WRITE
      tags:
      - Mappings
      description: '> **Required capabilities:** `hostedExtractors:WRITE`


        Delete a list of mappings by their external ID. This operation will fail if any mapping in the request is associated with a job, unless the `force` query parameter is set to `true`.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemsWithIgnoreUnknownIdsAndForce_ExternalId_'
        required: true
        description: List of external IDs of mappings to delete.
      responses:
        '200':
          $ref: '#/components/responses/EmptyResponse'
          description: Empty response
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      summary: Delete Mappings
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'client.hosted_extractors.mappings.delete(["myMapping", "MyMapping2"])

          '
  /hostedextractors/mappings/update:
    post:
      operationId: update_mappings
      x-capability:
      - hostedExtractors:WRITE
      tags:
      - Mappings
      description: '> **Required capabilities:** `hostedExtractors:WRITE`


        Update up to 100 mappings.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Items_MappingUpdateItem_'
        required: true
        description: Mappings to update.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Items_Mapping_'
          description: List of updated mappings.
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      summary: Update Mappings
      x-code-samples:
      - lang: Python
        label: Python SDK
        source: 'from cognite.client.data_classes.hosted_extractors import MappingUpdate

          mapping = MappingUpdate(''my_mapping'').published.set(False)

          res = client.hosted_extractors.mappings.update(mapping)

          '
components:
  parameters:
    100Limit:
      name: limit
      description: Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.
      in: query
      schema:
        type: integer
        default: 100
        minimum: 1
        maximum: 100
    Cursor:
      name: cursor
      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.

        '
      in: query
      schema:
        type: string
        example: 4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
  schemas:
    UpdateItem_CustomMapping_:
      additionalProperties: false
      properties:
        set:
          $ref: '#/components/schemas/CustomMapping'
      required:
      - set
      title: UpdateItem_CustomMapping
      type: object
      description: Set a new mapping value.
    CustomMapping:
      type: object
      properties:
        expression:
          type: string
          description: Custom transform expression written in the Cognite transformation language.
          maxLength: 2000
      required:
      - expression
    CsvConfig:
      additionalProperties: false
      type: object
      title: CSV
      description: 'Transform the input from a CSV (Comma Separated Values) file to a list of JSON objects. The input to the mapping will be a list on the form `[{\"header1\": \"value1\", ...}, ...]`.

        '
      properties:
        type:
          type: string
          enum:
          - csv
          description: Input type
          title: Type
        delimiter:
          type: string
          description: A single ASCII character used as the separator in the CSV file. Defaults to `,`
          maxLength: 1
          minLength: 1
          title: Delimiter
        customKeys:
          type: array
          minItems: 1
          maxItems: 20
          description: List of headers. If this is not set, the headers will be retrieved from the CSV file.
          items:
            type: string
            description: CSV file header value.
            title: CSV_Header
      required:
      - type
    EpochTimestamp:
      description: The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
      type: integer
      minimum: 0
      format: int64
      example: 1730204346000
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
    InputConfig:
      type: object
      description: Optionally set input mapping input type. This defaults to json if left out. Any input type is converted to JSON before being passed to the mapping expression.
      discriminator:
        mapping:
          protobuf: '#/components/schemas/ProtobufConfig'
          csv: '#/components/schemas/CsvConfig'
          xml: '#/components/schemas/XmlConfig'
          json: '#/components/schemas/JsonConfig'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/ProtobufConfig'
      - $ref: '#/components/schemas/CsvConfig'
      - $ref: '#/components/schemas/XmlConfig'
      - $ref: '#/components/schemas/JsonConfig'
    ExternalIdWrapper:
      additionalProperties: false
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
      required:
      - externalId
      title: ExternalIdWrapper
      type: object
    ValidationErrorContent:
      type: object
      required:
      - code
      - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 422
        message:
          type: string
          description: Error message.
          example: 'Extra inputs are not permitted: type'
    JsonConfig:
      additionalProperties: false
      type: object
      description: Treat the input as UTF-8 encoded JSON.
      title: JSON
      properties:
        type:
          type: string
          enum:
          - json
          description: Input type
          title: Type
      required:
      - type
    XmlConfig:
      additionalProperties: false
      type: object
      title: XML
      description: 'Transform the input from an XML file to a JSON object.

        '
      properties:
        type:
          type: string
          enum:
          - xml
          description: Input type
          title: Type
      required:
      - type
    Items_Mapping_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Mapping'
          title: Items
          type: array
          maxItems: 100
          minItems: 0
      required:
      - items
      title: MappingList
      type: object
    CreateProtoFile:
      additionalProperties: false
      description: Definition of a protobuf file used for loading input to the mapping.
      properties:
        fileName:
          type: string
          title: File Name
          format: '[a-zA-Z0-9_-]+\.proto'
          maxLength: 128
          description: Name of protobuf file. Must contain only letters, numbers, underscores, and hyphens, and must end with '.proto'.
        content:
          type: string
          title: Content
          description: Protobuf file content. Must be a valid protobuf file.
          maxLength: 10000
      required:
      - fileName
      - content
    Items_CreateMapping_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/CreateMapping'
          title: Items
          type: array
          minLength: 1
          maxLength: 10
      required:
      - items
      title: Items[CreateMapping]
      type: object
    ItemsWithIgnoreUnknownIds_ExternalId_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExternalIdWrapper'
          title: Items
          type: array
          maxItems: 100
          minItems: 1
        ignoreUnknownIds:
          type: boolean
          title: IgnoreUnknownIds
          description: Ignore IDs and external IDs that are not found
      required:
      - items
      title: ItemsWithIgnoreUnknownIds_ExternalId
      type: object
    ProtobufConfig:
      additionalProperties: false
      description: List of protobuf files used to define input to the mapping. This will be compiled to a collection of definitions which will be used to convert the input to JSON.
      title: ProtoBuf
      properties:
        type:
          type: string
          enum:
          - protobuf
          description: Input type
          title: Type
        messageName:
          type: string
          description: Name of root message in the protobuf files.
          maxLength: 128
          title: Message Name
        files:
          type: array
          maxItems: 20
          minItems: 1
          items:
            $ref: '#/components/schemas/ProtoFile'
      required:
      - messageName
      - files
      - type
    ItemsWithIgnoreUnknownIdsAndForce_ExternalId_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExternalIdWrapper'
          title: Items
          type: array
          maxItems: 100
          minItems: 1
        ignoreUnknownIds:
          type: boolean
          title: IgnoreUnknownIds
          description: Ignore IDs and external IDs that are not found.
        force:
          type: boolean
          title: Force
          description: Delete any jobs associated with each item.
      required:
      - items
      title: ItemsWithIgnoreUnknownIdsAndForce_ExternalId
      type: object
    ItemsWithCursor_Mapping_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Mapping'
          title: Items
          type: array
          maxItems: 100
          minItems: 0
        nextCursor:
          type: string
          title: Next cursor
          description: Cursor for pagination
      required:
      - items
      title: MappingList
      type: object
    CreateInputConfig:
      type: object
      description: Optionally set input mapping input type. This defaults to json if left out. Each input type is converted to JSON before being passed to the mapping expression.
      discriminator:
        mapping:
          protobuf: '#/components/schemas/CreateProtobufConfig'
          csv: '#/components/schemas/CsvConfig'
          xml: '#/components/schemas/XmlConfig'
          json: '#/components/schemas/JsonConfig'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/CreateProtobufConfig'
      - $ref: '#/components/schemas/CsvConfig'
      - $ref: '#/components/schemas/XmlConfig'
      - $ref: '#/components/schemas/JsonConfig'
    ProtoFile:
      additionalProperties: false
      description: Description of a protobuf file used for loading input to the mapping.
      properties:
        fileName:
          type: string
          title: File Name
          format: '[a-zA-Z0-9_-]+\.proto'
          maxLength: 128
          description: Name of protobuf file. Must contain only letters, numbers, underscores, and hyphens, and must end with '.proto'.
      required:
      - fileName
    UpdateSetNull:
      additionalProperties: false
      properties:
        setNull:
          title: SetNull
          type: boolean
          description: Clear this value
      required:
      - setNull
      title: UpdateSetNull
      type: object
    UpdateMapping:
      additionalProperties: false
      properties:
        mapping:
          $ref: '#/components/schemas/UpdateItem_CustomMapping_'
        input:
          anyOf:
          - $ref: '#/components/schemas/UpdateItem_InputConfig_'
          - $ref: '#/components/schemas/UpdateSetNull'
          description: Set or remove mapping input. When removed this defaults to json.
        published:
          additionalProperties: false
          properties:
            set:
              title: Set
              type: boolean
          required:
          - set
          type: object
          description: Publish or unpublish the mapping.
      title: UpdateMapping
      type: object
    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
    CreateProtobufConfig:
      additionalProperties: false
      description: List of protobuf files used to define input to the mapping. This will be compiled to a collection of definitions which will be used to convert the input to JSON.
      title: ProtoBuf
      properties:
        type:
          type: string
          enum:
          - protobuf
          description: Input type
          title: Type
        messageName:
          type: string
          description: Name of root message in the protobuf files.
          maxLength: 128
          title: Message Name
        files:
          type: array
          maxItems: 20
          minItems: 1
          description: List of protobuf files as text.
          items:
            $ref: '#/components/schemas/CreateProtoFile'
      required:
      - messageName
      - files
      - type
    Items_MappingUpdateItem_:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/MappingUpdateItem'
          title: Items
          type: array
          minItems: 1
          maxItems: 10
      required:
      - items
      title: MappingUpdateList
      type: object
    UpdateItem_InputConfig_:
      additionalProperties: false
      properties:
        set:
          $ref: '#/components/schemas/CreateInputConfig'
      required:
      - set
      title: UpdateItem_InputConfig
      type: object
      description: Set a new mapping input.
    MappingUpdateItem:
      additionalProperties: false
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
        update:
          $ref: '#/components/schemas/UpdateMapping'
      required:
      - externalId
      - update
      title: MappingUpdateItem
      type: object
    CreateMapping:
      additionalProperties: false
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
        mapping:
          $ref: '#/components/schemas/CustomMapping'
        input:
          $ref: '#/components/schemas/CreateInputConfig'
        published:
          title: Published
          type: boolean
          description: Whether this mapping is published and should be available to be used in jobs.
      required:
      - externalId
      - mapping
      - published
      title: CreateMapping
      type: object
    Mapping:
      additionalProperties: false
      properties:
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
        mapping:
          $ref: '#/components/schemas/CustomMapping'
        input:
          $ref: '#/components/schemas/InputConfig'
        published:
          title: Published
          type: boolean
          description: Whether this mapping is published and should be available to be used in jobs.
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
      required:
      - externalId
      - mapping
      - published
      - lastUpdatedTime
      - createdTime
      - input
      title: Mapping
      type: object
  responses:
    ValidationError:
      description: Validation Error
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/ValidationErrorContent'
    EmptyResponse:
      description: Empty response.
      content:
        application/json:
          schema:
            type: object
    400ErrorResponse:
      description: The response for a bad request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
          example:
            error:
              code: 400
              message: '`null` values aren''t allowed.'
  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-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
    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
    org-oidc-token:
      type: openIdConnect
      openIdConnectUrl: https://auth.cognite.com/.well-known/openid-configuration
      description: 'Access token issued by the Cognite authorization server, and valid for the target organization. The token must

        be an OpenID Connect token, and it can be obtained by performing an OIDC login flow toward `auth.cognite.com`.

        This is a single URL for all CDF organizations.'
x-tagGroups:
- name: Changelog
  tags:
  - Changelog
- name: Organizations and projects
  tags:
  - Organizations
  - Projects
- name: Identity and access management
  tags:
  - Principals
  - Groups
  - Security categories
  - Sessions
  - Token
  - User profiles
  - Project Deletion Reporting
- name: Data modeling
  tags:
  - Data Modeling
  - Data models
  - Spaces
  - Views
  - Containers
  - Nodes
  - Instances
  - Statistics
  - Streams
  - Records
- name: Asset-centric data model
  tags:
  - Assets
  - Time series
  - Synthetic Time Series
  - Data point subscriptions
  - Events
  - Files
  - Sequences
  - Geospatial
  - Seismic
- name: 3D
  tags:
  - 3D Models
  - 3D Model Revisions
  - 3D Files
  - 3D Asset Mapping
  - 3D Contextualization
  - 3D Jobs
  - 3D Migration
  - 3D Scenes
- name: Contextualization
  tags:
  - Entity matching
  - Entity matching pipelines
  - Engineering diagrams
  - Vision
  - Advanced joins
- name: Cognite AI
  tags:
  - Agents
  - Skills
  - Chat Completions
  - Document AI
  - Models
- name: Documents
  tags:
  - Documents
  - Document preview
- name: Data ingestion
  tags:
  - Raw
  - Extraction Pipelines
  - Extraction Pipelines Runs
  - Extraction Pipelines Config
  - Extractors
- name: Data organization
  tags:
  - Data sets
  - Data domains
  - Data products
  - Rule sets
  - Labels
  - Relationships
  - Annotations
- name: Transformations
  tags:
  - Transformations
  - Transformation Jobs
  - Transformation Schedules
  - Transformation Notifications
  - Query
  - Schema
- name: Functions
  tags:
  - Functions
  - Function calls
  - Function schedules
- name: Hosted Extractors
  tags:
  - Sources
  - Jobs
  - Destinations
  - Mappings
- name: PostgreSQL Gateway
  tags:
  - Postgres Gateway Users
  - Postgres Gateway Tables
- name: SAP Writeback
  tags:
  - SAP Instances
  - SAP Endpoints
  - Schema Mappings
  - Writeback Requests
- name: Data workflows
  tags:
  - Workflows
  - Workflow versions
  - Workflow executions
  - Workflow triggers
  - Tasks
  - Workers
- name: Simulators
  tags:
  - Simulators
  - Simulator Integrations
  - Simulator Models
  - Simulator Routines
  - Simulation Runs
  - Simulator Logs
- name: Units
  tags:
  - Units
  - Unit Systems
- name: ''
  tags:
  - ''