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>"
}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.
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>"
}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.
External ID of a diagram The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
A single diagram with its entities and connections
Diagram with all of its entities and connections joined
Show child attributes
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
List of entities of this diagram
Show child attributes
The external ID of the diagram
255"my.known.id"
ID of a file the diagram is parsed from
Show child attributes
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The external ID of a library the diagram is parsed with
255"my.known.id"
The page number of a file the diagram is parsed from
Parsing status of a diagram
Failed, InProgress, InQueue, Pending, Success Message containing errors or other information for a diagram
Was this page helpful?