Filter diagrams

Filter and retrieve up to 100 diagrams by specifying their properties.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Body contains the properties to filter on.

Array ([ 1 .. 100 ] items)
Array of objects (DmsId)

DMS identifier of a file the diagram is parsed from

libraryId
Array of strings (CogniteExternalId)

The external ID of the library the diagram is parsed with

pageNumber
Array of integers

The page number of a file the diagram is parsed from

status
Array of strings (ParseStatus)

Parsing status of a diagram

Items Enum: "Failed" "InProgress" "InQueue" "Pending" "Success"
Responses
200

List of diagrams

400

The response for a failed request.

post/diagram-parsing/diagrams/list
Request samples
application/json
[
  • {
    • "fileId": [
      ],
    • "libraryId": [
      ],
    • "pageNumber": [
      ],
    • "status": [
      ]
    }
]
Response samples
application/json
{
  • "items": [
    • {
      }
    ]
}
➔ Next to Get an extended diagram by external id