Get an extended diagram with paths by external id

Get a single diagram containing entities, connections, and SVG data by using its external id

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
diagramId
required
string (CogniteExternalId) <= 255 characters

External ID of a diagram

Example: my.known.id
query Parameters
cursor
string

Cursor for paging through results.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
Responses
200

Diagram with its entities, connections, and SVG paths data

400

The response for a failed request.

get/diagram-parsing/diagrams/{diagramId}/with-paths
Request samples 
Response samples 
application/json
{
  • "connections": [
    • {
      }
    ],
  • "createdTime": 1730204346000,
  • "entities": [
    • {
      }
    ],
  • "externalId": "my.known.id",
  • "fileId": {
    • "space": "string",
    • "externalId": "my.known.id"
    },
  • "height": "string",
  • "lastUpdatedTime": 1730204346000,
  • "libraryId": "my.known.id",
  • "message": "string",
  • "pageNumber": 0,
  • "status": "Failed",
  • "viewBox": "string",
  • "width": "string"
}
➔ Next to List diagrams