Skip to main content
GET
/
diagram-parsing
/
diagrams
/
{diagramId}
Get an extended diagram by external id
curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/{diagramId} \
  --header 'Authorization: Bearer <token>'
{
  "connections": [
    {
      "createdTime": 1730204346000,
      "diagramId": "my.known.id",
      "endNodeId": "my.known.id",
      "externalId": "my.known.id",
      "isUserDetected": true,
      "lastUpdatedTime": 1730204346000,
      "startNodeId": "my.known.id"
    }
  ],
  "createdTime": 1730204346000,
  "entities": [
    {
      "createdTime": 1730204346000,
      "diagramId": "my.known.id",
      "externalId": "my.known.id",
      "isAssetVerified": true,
      "isUserDetected": true,
      "lastUpdatedTime": 1730204346000,
      "pathIds": [
        "<string>"
      ],
      "symbolId": "my.known.id",
      "annotationId": {
        "space": "<string>",
        "externalId": "my.known.id"
      },
      "assetId": {
        "space": "<string>",
        "externalId": "my.known.id"
      }
    }
  ],
  "externalId": "my.known.id",
  "fileId": {
    "space": "<string>",
    "externalId": "my.known.id"
  },
  "lastUpdatedTime": 1730204346000,
  "libraryId": "my.known.id",
  "pageNumber": 123,
  "status": "Failed",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

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.

Path Parameters

diagramId
string
required

External ID of a diagram The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

Response

A single diagram with its entities and connections

Diagram with all of its entities and connections joined

connections
object[]
required
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

entities
object[]
required

List of entities of this diagram

externalId
string
required

The external ID of the diagram

Maximum string length: 255
Example:

"my.known.id"

fileId
object
required

ID of a file the diagram is parsed from

lastUpdatedTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

libraryId
string
required

The external ID of a library the diagram is parsed with

Maximum string length: 255
Example:

"my.known.id"

pageNumber
integer
required

The page number of a file the diagram is parsed from

status
enum<string>
required

Parsing status of a diagram

Available options:
Failed,
InProgress,
InQueue,
Pending,
Success
message
string

Message containing errors or other information for a diagram

Last modified on April 23, 2026