Get an extended diagram by external id

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.

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
Responses
200

A single diagram with its entities and connections

400

The response for a failed request.

get/diagram-parsing/diagrams/{diagramId}
Request samples 
Response samples 
application/json
{
  • "connections": [
    • {
      }
    ],
  • "createdTime": 1730204346000,
  • "entities": [
    • {
      }
    ],
  • "externalId": "my.known.id",
  • "fileId": {
    • "space": "string",
    • "externalId": "my.known.id"
    },
  • "lastUpdatedTime": 1730204346000,
  • "libraryId": "my.known.id",
  • "pageNumber": 0,
  • "message": "string",
  • "status": "Failed"
}
➔ Next to Get an extended diagram by file reference