Cognite Symbols API

openapi: 3.2.0
info:
  title: Cognite Symbols 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: Symbols
paths:
  /diagram-parsing/symbols:
    get:
      tags:
      - Symbols
      summary: List symbols
      description: '> **Required capabilities:** `diagramParsingAcl:READ`


        List all symbols defined in the current project.'
      operationId: listSymbols
      parameters:
      - $ref: '#/components/parameters/Cursor'
      - $ref: '#/components/parameters/libraryIdQuery'
      x-capability:
      - diagramParsingAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/SymbolsListWithCursorResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - Symbols
      summary: Create symbols
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Create symbols'
      operationId: createSymbols
      requestBody:
        description: List of symbols to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSymbolsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/SymbolsListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/symbols/byids:
    post:
      tags:
      - Symbols
      summary: Retrieve symbols
      description: '> **Required capabilities:** `diagramParsingAcl:READ`


        Retrieve up to 100 symbols by specifying their IDs.'
      operationId: multiGetSymbols
      requestBody:
        description: List of IDs for the symbols to return.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalIdsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:READ
      responses:
        '200':
          $ref: '#/components/responses/SymbolsListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/symbols/delete:
    post:
      tags:
      - Symbols
      summary: Delete symbols
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Delete up to 100 symbols by specifying their IDs.'
      operationId: deleteSymbols
      requestBody:
        description: List of symbols IDs to delete.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalIdsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/ExternalIdsResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /diagram-parsing/symbols/update:
    post:
      tags:
      - Symbols
      summary: Update symbols
      description: '> **Required capabilities:** `diagramParsingAcl:WRITE`


        Update the properties of a set of symbols'
      operationId: updateSymbols
      requestBody:
        description: List of symbols to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSymbolsRequest'
        required: true
      x-capability:
      - diagramParsingAcl:WRITE
      responses:
        '200':
          $ref: '#/components/responses/SymbolsListResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    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
    ExternalIdsRequest:
      type: object
      required:
      - items
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            required:
            - externalId
            properties:
              externalId:
                $ref: '#/components/schemas/CogniteExternalId'
    SymbolUpdateDraft:
      type: object
      properties:
        assetTypeId:
          $ref: '#/components/schemas/DmsId'
    SymbolDto:
      type: object
      required:
      - assetTypeId
      - createdTime
      - externalId
      - lastUpdatedTime
      - libraryId
      properties:
        assetTypeId:
          $ref: '#/components/schemas/DmsId'
        createdTime:
          $ref: '#/components/schemas/EpochTimestamp'
        externalId:
          description: The external ID of the symbol
          $ref: '#/components/schemas/CogniteExternalId'
        lastUpdatedTime:
          $ref: '#/components/schemas/EpochTimestamp'
        libraryId:
          description: The external ID of a library the symbol belongs to
          $ref: '#/components/schemas/CogniteExternalId'
    UpdateSymbolsRequest:
      type: object
      required:
      - items
      description: List of symbols to update
      minItems: 1
      maxItems: 100
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/SymbolUpdateItem'
    CreateSymbolsRequest:
      type: object
      required:
      - items
      description: List of symbols to create
      minItems: 1
      maxItems: 100
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: object
            $ref: '#/components/schemas/SymbolCreateDraft'
    NextCursorV3:
      description: The cursor value used to return (paginate to) the next page of results, when more data is available.
      type: string
    SymbolCreateDraft:
      type: object
      required:
      - assetTypeId
      - externalId
      - libraryId
      properties:
        assetTypeId:
          description: The DMS identifier of the asset type that the symbol represents
          $ref: '#/components/schemas/DmsId'
        externalId:
          description: The external ID of the symbol
          $ref: '#/components/schemas/CogniteExternalId'
        libraryId:
          description: The external ID of a library the symbol belongs to
          $ref: '#/components/schemas/CogniteExternalId'
    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
    SymbolUpdateItem:
      type: object
      required:
      - externalId
      - update
      properties:
        externalId:
          description: The external ID of the symbol
          $ref: '#/components/schemas/CogniteExternalId'
        update:
          description: The properties to be updated
          $ref: '#/components/schemas/SymbolUpdateDraft'
    CogniteExternalId:
      description: The external ID provided by the client. Must be unique for the resource type.
      type: string
      maxLength: 255
      example: my.known.id
    DmsId:
      description: A DMS Identifier using the space and externalId
      type: object
      required:
      - space
      - externalId
      properties:
        space:
          type: string
        externalId:
          $ref: '#/components/schemas/CogniteExternalId'
  parameters:
    libraryIdQuery:
      name: libraryId
      description: Retrieve items related to this library
      in: query
      schema:
        $ref: '#/components/schemas/CogniteExternalId'
    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
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
    ExternalIdsResponse:
      description: List of external IDs returned in a response
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                minItems: 1
                maxItems: 100
                items:
                  $ref: '#/components/schemas/CogniteExternalId'
    SymbolsListResponse:
      description: List of symbols
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                items:
                  $ref: '#/components/schemas/SymbolDto'
    SymbolsListWithCursorResponse:
      description: List of symbols with next cursor
      content:
        application/json:
          schema:
            type: object
            required:
            - items
            properties:
              items:
                type: array
                items:
                  $ref: '#/components/schemas/SymbolDto'
              nextCursor:
                $ref: '#/components/schemas/NextCursorV3'
  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:
  - ''