Skip to main content
POST
/
diagram-parsing
/
diagrams
/
list
Filter diagrams
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>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

application/json

Body contains the properties to filter on.

Required array length: 1 - 100 elements
fileId
object[]

DMS identifier of a file the diagram is parsed from

libraryId
string[]

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.

Maximum string length: 255
pageNumber
integer[]

The page number of a file the diagram is parsed from

status
enum<string>[]

Parsing status of a diagram

Status of a parsing job

Available options:
Failed,
InProgress,
InQueue,
Pending,
Success

Response

List of diagrams

items
object[]
required
Last modified on April 23, 2026