curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"fileId": [
{
"space": "<string>",
"externalId": "my.known.id"
}
],
"libraryId": [
"my.known.id"
],
"pageNumber": [
123
],
"status": [
"Failed"
]
}
]
'{
"items": [
{
"createdTime": 1730204346000,
"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
Filter and retrieve up to 100 diagrams by specifying their properties.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/diagrams/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"fileId": [
{
"space": "<string>",
"externalId": "my.known.id"
}
],
"libraryId": [
"my.known.id"
],
"pageNumber": [
123
],
"status": [
"Failed"
]
}
]
'{
"items": [
{
"createdTime": 1730204346000,
"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.
Body contains the properties to filter on.
1 - 100 elementsDMS identifier of a file the diagram is parsed from
Show child attributes
The external ID of the library the diagram is parsed with
The external ID provided by the client. Must be unique for the resource type.
255The page number of a file the diagram is parsed from
Parsing status of a diagram
Status of a parsing job
Failed, InProgress, InQueue, Pending, Success List of diagrams
Show child attributes
Was this page helpful?