Cognite Diagrams API
The Diagrams API from Cognite — 6 operation(s) for diagrams.
The Diagrams API from Cognite — 6 operation(s) for diagrams.
openapi: 3.1.0
info:
title: Cognite 3D Asset Mapping Diagrams 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: Diagrams
paths:
/diagram-parsing/diagrams:
get:
tags:
- Diagrams
summary: List diagrams
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
List all diagrams defined in the current project.'
operationId: listDiagrams
parameters:
- $ref: '#/components/parameters/Cursor'
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/DiagramsListWithCursorResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/diagrams/byids:
post:
tags:
- Diagrams
summary: Retrieve diagrams
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
Retrieve up to 100 diagrams by specifying their external IDs.'
operationId: multiGetDiagrams
requestBody:
description: List of IDs for the diagrams to return.
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalIdsRequest'
required: true
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/DiagramsListResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/diagrams/list:
post:
tags:
- Diagrams
summary: Filter diagrams
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
Filter and retrieve up to 100 diagrams by specifying their properties.'
operationId: filterDiagrams
requestBody:
description: Body contains the properties to filter on.
content:
application/json:
schema:
$ref: '#/components/schemas/DiagramFilters'
required: true
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/DiagramsListResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/diagrams/{diagramId}:
get:
tags:
- Diagrams
summary: Get an extended diagram by external id
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
Get diagram information and its parsed outputs using the diagram ID. The parsed output includes all diagram entities and their connections extracted during the file parsing process.'
operationId: getExtendedDiagramById
parameters:
- $ref: '#/components/parameters/diagramIdPath'
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/ExtendedDiagramResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/diagrams/{fileSpace}/{fileExternalId}/{pageNumber}:
get:
tags:
- Diagrams
summary: Get an extended diagram by file reference
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
Get diagram information and its parsed outputs using its related fileId and pageNumber. The parsed output includes all diagram entities and their connections extracted during the file parsing process.'
operationId: getExtendedDiagramByFilePage
parameters:
- $ref: '#/components/parameters/fileSpace'
- $ref: '#/components/parameters/fileExternalId'
- $ref: '#/components/parameters/pageNumber'
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/ExtendedDiagramResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
/diagram-parsing/diagrams/{diagramId}/with-paths:
get:
tags:
- Diagrams
summary: Get an extended diagram with paths by external id
description: '
> **Required capabilities:** `diagramParsingAcl:READ`
Get a single diagram containing entities, connections, and SVG data by using its external id'
operationId: getExtendedDiagramWithPaths
parameters:
- $ref: '#/components/parameters/Cursor'
- $ref: '#/components/parameters/diagramIdPath'
x-capability:
- diagramParsingAcl:READ
responses:
'200':
$ref: '#/components/responses/ExtendedDiagramWithPathsResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
components:
schemas:
DiagramFilters:
type: array
description: List of filters used to filter diagrams
minItems: 1
maxItems: 100
items:
$ref: '#/components/schemas/DiagramFilter'
ParseStatus:
description: Status of a parsing job
type: string
enum:
- Failed
- InProgress
- InQueue
- Pending
- Success
CogniteExternalId:
description: The external ID provided by the client. Must be unique for the resource type.
type: string
maxLength: 255
example: my.known.id
ConnectionDto:
description: Connection between two entities in a diagram. The connected entities can either be in the same or different diagrams.
type: object
required:
- createdTime
- diagramId
- endNodeId
- externalId
- isUserDetected
- lastUpdatedTime
- startNodeId
properties:
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
diagramId:
description: The external ID of a diagram the connection belongs to
$ref: '#/components/schemas/CogniteExternalId'
endNodeId:
description: The external ID of a diagram entity with a connection to the other diagram entity
$ref: '#/components/schemas/CogniteExternalId'
externalId:
description: The external ID of the connection
$ref: '#/components/schemas/CogniteExternalId'
isUserDetected:
description: Checks whether the connection was detected by a user or not. Returns a boolean value.
type: boolean
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
startNodeId:
description: The external ID of a diagram entity with a connection to the other diagram entity
$ref: '#/components/schemas/CogniteExternalId'
DmsId:
description: A DMS Identifier using the space and externalId
type: object
required:
- space
- externalId
properties:
space:
type: string
externalId:
$ref: '#/components/schemas/CogniteExternalId'
Path:
description: SVG path in a custom format
type: object
required:
- id
- d
properties:
id:
type: string
d:
description: The d attribute of an SVG path
type: string
styleId:
description: The id of the style used for this path
type: string
ExtendedDiagramWithPathsDto:
description: Diagram with its entities, connections, and SVG paths data
type: object
required:
- connections
- createdTime
- entities
- externalId
- fileId
- height
- lastUpdatedTime
- libraryId
- pageNumber
- status
- viewBox
- width
properties:
connections:
type: array
items:
$ref: '#/components/schemas/ConnectionDto'
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
entities:
type: array
items:
$ref: '#/components/schemas/EntityWithPathsDto'
externalId:
description: The external ID of the diagram
$ref: '#/components/schemas/CogniteExternalId'
fileId:
description: ID of a file the diagram is parsed from
$ref: '#/components/schemas/DmsId'
height:
description: Height attribute of the SVG diagram
type: string
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
libraryId:
description: The external ID of a library the diagram is parsed with
$ref: '#/components/schemas/CogniteExternalId'
message:
description: Message containing errors or other information
type: string
pageNumber:
description: The page number of a file the diagram is parsed from
type: integer
status:
description: Parsing status of a diagram
$ref: '#/components/schemas/ParseStatus'
viewBox:
description: ViewBox attribute of the SVG diagram
type: string
width:
description: Width attribute of the SVG diagram
type: string
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
ExtendedDiagramDto:
description: Diagram with all of its entities and connections joined
type: object
required:
- connections
- createdTime
- entities
- externalId
- fileId
- lastUpdatedTime
- libraryId
- pageNumber
- status
properties:
connections:
type: array
items:
$ref: '#/components/schemas/ConnectionDto'
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
entities:
description: List of entities of this diagram
type: array
items:
$ref: '#/components/schemas/EntityDto'
externalId:
description: The external ID of the diagram
$ref: '#/components/schemas/CogniteExternalId'
fileId:
description: ID of a file the diagram is parsed from
$ref: '#/components/schemas/DmsId'
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
libraryId:
description: The external ID of a library the diagram is parsed with
$ref: '#/components/schemas/CogniteExternalId'
pageNumber:
description: The page number of a file the diagram is parsed from
type: integer
message:
description: Message containing errors or other information for a diagram
type: string
status:
description: Parsing status of a diagram
$ref: '#/components/schemas/ParseStatus'
EntityDto:
type: object
required:
- createdTime
- diagramId
- externalId
- isAssetVerified
- isUserDetected
- lastUpdatedTime
- pathIds
- symbolId
properties:
annotationId:
description: DMS identifier of a linked Diagram Annotation
$ref: '#/components/schemas/DmsId'
assetId:
description: DMS identifier of a mapped asset
$ref: '#/components/schemas/DmsId'
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
diagramId:
description: The external ID of a diagram this entity belongs to
$ref: '#/components/schemas/CogniteExternalId'
externalId:
description: The external ID of the diagram entity
$ref: '#/components/schemas/CogniteExternalId'
isAssetVerified:
description: Determines if a diagram entity has a verified asset mapping
type: boolean
isUserDetected:
description: Determines if a diagram entity was detected manually
type: boolean
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
pathIds:
type: array
items:
type: string
symbolId:
description: The external ID of the symbol this diagram entity is detected as
$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
DiagramFilter:
type: object
description: List of properties used to filter diagrams
minItems: 1
maxItems: 100
properties:
fileId:
description: DMS identifier of a file the diagram is parsed from
type: array
items:
$ref: '#/components/schemas/DmsId'
libraryId:
description: The external ID of the library the diagram is parsed with
type: array
items:
$ref: '#/components/schemas/CogniteExternalId'
pageNumber:
description: The page number of a file the diagram is parsed from
type: array
items:
type: integer
status:
description: Parsing status of a diagram
type: array
items:
$ref: '#/components/schemas/ParseStatus'
NextCursorV3:
description: The cursor value used to return (paginate to) the next page of results, when more data is available.
type: string
EntityWithPathsDto:
description: Diagram entity with its paths joined by pathIds
type: object
required:
- createdTime
- diagramId
- externalId
- isAssetVerified
- isUserDetected
- lastUpdatedTime
- paths
- symbolId
properties:
annotationId:
description: DMS identifier of a linked diagram annotation
$ref: '#/components/schemas/DmsId'
assetId:
description: DMS identifier of a mapped asset
$ref: '#/components/schemas/DmsId'
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
diagramId:
description: The external ID of a diagram the entity belongs to
$ref: '#/components/schemas/CogniteExternalId'
externalId:
description: The external ID of the diagram entity
$ref: '#/components/schemas/CogniteExternalId'
isAssetVerified:
description: Determines if a diagram entity has a verified asset mapping
type: boolean
isUserDetected:
description: Determines if a diagram entity was detected manually
type: boolean
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
paths:
type: array
items:
$ref: '#/components/schemas/Path'
symbolId:
description: The external ID of the symbol this diagram entity is detected as
$ref: '#/components/schemas/CogniteExternalId'
ExternalIdsRequest:
type: object
required:
- items
properties:
items:
type: array
minItems: 1
maxItems: 100
items:
type: object
required:
- externalId
properties:
externalId:
$ref: '#/components/schemas/CogniteExternalId'
DiagramDto:
type: object
required:
- createdTime
- externalId
- fileId
- lastUpdatedTime
- libraryId
- pageNumber
- status
properties:
createdTime:
$ref: '#/components/schemas/EpochTimestamp'
externalId:
description: The external ID of the diagram
$ref: '#/components/schemas/CogniteExternalId'
fileId:
description: DMS identifier of a file the diagram is parsed from
$ref: '#/components/schemas/DmsId'
lastUpdatedTime:
$ref: '#/components/schemas/EpochTimestamp'
libraryId:
description: The external ID of a library the diagram is parsed with
$ref: '#/components/schemas/CogniteExternalId'
message:
description: Message containing errors or other information
type: string
pageNumber:
description: The page number of a file the diagram is parsed from
type: integer
status:
description: Parsing status of a diagram
$ref: '#/components/schemas/ParseStatus'
parameters:
diagramIdPath:
name: diagramId
description: External ID of a diagram
required: true
in: path
schema:
$ref: '#/components/schemas/CogniteExternalId'
pageNumber:
name: pageNumber
description: The file's page number
required: true
in: path
schema:
type: integer
fileExternalId:
name: fileExternalId
description: Retrieve data related to a file
required: true
in: path
schema:
type: string
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
fileSpace:
name: fileSpace
description: A DMS space where the files reside
required: true
in: path
schema:
type: string
responses:
ExtendedDiagramWithPathsResponse:
description: Diagram with its entities, connections, and SVG paths data
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedDiagramWithPathsDto'
DiagramsListWithCursorResponse:
description: List of diagrams with next cursor
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiagramDto'
nextCursor:
$ref: '#/components/schemas/NextCursorV3'
ErrorResponse:
description: The response for a failed request.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/Error'
DiagramsListResponse:
description: List of diagrams
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/DiagramDto'
ExtendedDiagramResponse:
description: A single diagram with its entities and connections
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedDiagramDto'
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:
- ''