curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/entities/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"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"
}
}
]
}Required capabilities:
DiagramParsingAcl:READ
Retrieve up to 100 diagram entities by specifying their IDs.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/entities/byids \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"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"
}
}
]
}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.
List of IDs for the diagram entities to return.
1 - 100 elementsShow child attributes
List of diagram entities
Show child attributes
Was this page helpful?