Cognite Data Fusion API

Get an extended diagram by file reference

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.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code

Request

path Parameters

fileSpace required	string A DMS space where the files reside
fileExternalId required	string Retrieve data related to a file
pageNumber required	integer The file's page number

Responses

200

A single diagram with its entities and connections

400

The response for a failed request.

get/diagram-parsing/diagrams/{fileSpace}/{fileExternalId}/{pageNumber}

Request samples

curl

Response samples

application/json

{"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": [{"annotationId": {"space": "string",
"externalId": "my.known.id"
},
"assetId": {"space": "string",
"externalId": "my.known.id"
},
"createdTime": 1730204346000,
"diagramId": "my.known.id",
"externalId": "my.known.id",
"isAssetVerified": true,
"isUserDetected": true,
"lastUpdatedTime": 1730204346000,
"pathIds": ["string"
],
"symbolId": "my.known.id"
}
],
"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 with paths by external id