Cognite Schema API
Schema provides the expected schema for CDF resources.
OpenAPI Specification
openapi: 3.1.0
info:
title: Cognite 3D Asset Mapping Schema API
description: "# Introduction\nThis is the reference documentation for the Cognite API with\nan overview of all the available methods.\n\n# Postman\nSelect the **Download** button to download our OpenAPI specification to get started.\n\nTo import your data into Postman, select **Import**, and the Import modal opens.\nYou can import items by dragging or dropping files or folders. You can choose how to import your API and manage the import settings in **View Import Settings**.\n\nIn the Import Settings, set the **Folder organization** to **Tags**, select\n**Enable optional parameters** to turn off the settings, and select **Always inherit authentication** to turn on the settings. Select **Import**.\n\nSet the Authorization to **Oauth2.0**. By default, the settings are for Open Industrial Data. Navigate to [Cognite Hub](https://hub.cognite.com/open-industrial-data-211) to understand how to get the credentials for use in Postman.\n\nFor more information, see [Getting Started with Postman](https://developer.cognite.com/dev/guides/postman/).\n\n# Pagination\nMost resource types can be paginated, indicated by the field `nextCursor` in the response.\nBy passing the value of `nextCursor` as the cursor you will get the next page of `limit` results.\nNote that all parameters except `cursor` has to stay the same.\n\n# Parallel retrieval\nAs general guidance, Parallel Retrieval is a technique that should be used when due to query complexity, retrieval of data in a single request is significantly slower than it would otherwise be for a simple request. Parallel retrieval does not act as a speed multiplier on optimally running queries. By parallelizing such requests, data retrieval performance can be tuned to meet the client application needs. \n\nCDF supports parallel retrieval through the `partition` parameter, which has the format `m/n` where `n` is the amount of partitions you would like to split the entire data set into.\nIf you want to download the entire data set by splitting it into 10 partitions, do the following in parallel with `m` running from 1 to 10:\n - Make a request to `/events` with `partition=m/10`.\n - Paginate through the response by following the cursor as explained above. Note that the `partition` parameter needs to be passed to all subqueries.\n\nProcessing of parallel retrieval requests is subject to concurrency quota availability. The request returns the `429` response upon exceeding concurrency limits. See the Request throttling chapter below.\n\nTo prevent unexpected problems and to maximize read throughput, you should at most use 10 partitions. \nSome CDF resources will automatically enforce a maximum of 10 partitions.\nFor more specific and detailed information, please read the ```partition``` attribute documentation for the CDF resource you're using. \n\n# Requests throttling\nCognite Data Fusion (CDF) returns the HTTP `429` (too many requests) response status code when project capacity exceeds the limit.\n\nThe throttling can happen:\n - If a user or a project sends too many (more than allocated) concurrent requests.\n - If a user or a project sends a too high (more than allocated) rate of requests in a given amount of time.\n\nCognite recommends using a retry strategy based on truncated exponential backoff to handle sessions with HTTP response codes 429.\n\nCognite recommends using a reasonable number (up to 10) of `Parallel retrieval` partitions.\n\nFollowing these strategies lets you slow down the request frequency to maximize productivity without having to re-submit/retry failing requests.\n\nSee more [here](https://docs.cognite.com/dev/concepts/resource_throttling).\n\n# API versions\n## Version headers\nThis API uses calendar versioning, and version names follow the `YYYYMMDD` format.\nYou can find the versions currently available by using the version selector at the top of this page.\n\nTo use a specific API version, you can pass the `cdf-version: $version` header along with your requests to the API.\n\n## Beta versions\nThe beta versions provide a preview of what the stable version will look like in the future.\nBeta versions contain functionality that is reasonably mature, and highly likely to become a part of the stable API.\n\nBeta versions are indicated by a `-beta` suffix after the version name. For example, the beta version header for the\n2023-01-01 version is then `cdf-version: 20230101-beta`.\n\n## Alpha versions\nAlpha versions contain functionality that is new and experimental, and not guaranteed to ever become a part of the stable API.\nThis functionality presents no guarantee of service, so its use is subject to caution.\n\nAlpha versions are indicated by an `-alpha` suffix after the version name. For example, the alpha version header for\nthe 2023-01-01 version is then `cdf-version: 20230101-alpha`."
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: Schema
description: Schema provides the expected schema for CDF resources.
paths:
/transformations/schema/sequence_rows:
get:
tags:
- Schema
summary: Get the schema of a sequence
operationId: getTransformationSequenceRowSchema
parameters:
- name: externalId
in: query
description: External ID of the Sequence
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: Response with the schema columns of the target schema type
content:
application/json:
schema:
$ref: '#/components/schemas/Items_ColumnType'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:READ
description: '
> **Required capabilities:** `transformationsAcl:READ`
'
/transformations/schema/instances:
get:
tags:
- Schema
summary: Get Instance schema.
description: '
> **Required capabilities:** `transformationsAcl:READ`
For View centric schema, `viewSpace`, `viewExternalId`, `viewVersion` need to be specified while `withInstanceSpace`, `isConnectionDefinition`, `instanceType` are optional . For Data Model centric schema, `dataModelSpace`, `dataModelExternalId`, `dataModelVersion`, `type` need to be specified and `relationshipFromType` is optional. For Both scenarios `conflictMode` is required.'
operationId: getFlexibleDataModelInstanceSchema
parameters:
- name: conflictMode
in: query
description: "conflict mode of the transformation.\n One of the following conflictMode types can be provided:\n `upsert`, `delete`\n "
required: false
schema:
type: string
enum:
- abort
- upsert
- update
- delete
- name: viewSpace
in: query
description: Space of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema.
required: false
schema:
type: string
minLength: 1
- name: viewExternalId
in: query
description: External id of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema.
required: false
schema:
type: string
minLength: 1
- name: viewVersion
in: query
description: Version of the View. Not required if `isConnectionDefinition` is true. Relevant for View centric schema.
required: false
schema:
type: string
minLength: 1
- name: instanceType
in: query
description: Instance type to deal with
required: false
schema:
type: string
enum:
- nodes
- edges
- name: withInstanceSpace
in: query
description: Is instance space set at the transformation config or not
required: false
schema:
type: boolean
- name: isConnectionDefinition
in: query
description: If the edge is a connection definition or not
required: false
schema:
type: boolean
- name: dataModelSpace
in: query
description: Space of the Data Model. Relevant for Data Model centric schema.
required: false
schema:
type: string
minLength: 1
- name: dataModelExternalId
in: query
description: External id of the Data Model. Relevant for Data Model centric schema.
required: false
schema:
type: string
minLength: 1
- name: dataModelVersion
in: query
description: Version of the Data Model. Relevant for Data Model centric schema.
required: false
schema:
type: string
minLength: 1
- name: type
in: query
description: External id of the View in the Data model. Relevant for Data Model centric schema.
required: false
schema:
type: string
minLength: 1
- name: relationshipFromType
in: query
description: Property Identifier of Connection Definition in `type`. Relevant for Data Model centric schema.
required: false
schema:
type: string
minLength: 1
responses:
'200':
description: Response with the schema columns of the target schema type
content:
application/json:
schema:
$ref: '#/components/schemas/Items_ColumnType'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:READ
/transformations/schema/{schemaType}:
get:
tags:
- Schema
summary: Get the schema of resource type
operationId: getTransformationSchema
parameters:
- name: schemaType
in: path
description: "Name of the target schema type, please provide one of the following:\n `assets`, `timeseries`, `asset_hierarchy`, `events`, `datapoints`\n `string_datapoints`, `sequences`, `files`, `labels`,\n `relationships`, `raw`, `data_sets`"
required: true
schema:
type: string
- name: conflictMode
in: query
description: "One of the following conflictMode types can be provided:\n `abort`, `upsert`, `update`, `delete`"
required: false
schema:
type: string
responses:
'200':
description: Response with the schema columns of the target schema type
content:
application/json:
schema:
$ref: '#/components/schemas/Items_ColumnType'
'400':
description: The response for a failed request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
'403':
description: The response for a forbidden request.
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- message
type: object
properties:
code:
type: integer
description: HTTP status code.
message:
type: string
description: Error message.
missing:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of lookup objects that do not match any results.
duplicated:
type: array
items:
oneOf:
- $ref: '#/components/schemas/TransformationCogniteExternalId'
- $ref: '#/components/schemas/TransformationCogniteInternalId'
description: List of objects that are not unique.
x-capability: transformationsAcl:READ
x-code-samples:
- lang: Python
label: Python SDK
source: 'from cognite.client.data_classes import TransformationDestination
columns = client.transformations.schema.retrieve(destination = TransformationDestination.assets())
'
description: '
> **Required capabilities:** `transformationsAcl:READ`
'
components:
schemas:
TransformationCogniteInternalId:
required:
- id
type: object
properties:
id:
type: integer
description: A server-generated ID for the object.
format: int32
CogniteExternalId:
description: The external ID provided by the client. Must be unique for the resource type.
type: string
maxLength: 255
example: my.known.id
ColumnType:
required:
- name
- sqlType
- type
- nullable
type: object
properties:
name:
type: string
description: Column name.
sqlType:
type: string
description: Type of the column in sql format.
type:
description: Type of the column in json format.
oneOf:
- required:
- type
type: object
properties:
type:
type: string
- type: string
nullable:
type: boolean
description: Values for the column can be null or not.
description: Details of a column in a given schema.
Items_ColumnType:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ColumnType'
TransformationCogniteExternalId:
required:
- externalId
type: object
properties:
externalId:
$ref: '#/components/schemas/CogniteExternalId'
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:
- ''