Cognite Data Fusion API

Run an instant parsing job for a file

Start an instant parsing job on a file to detect diagram symbols based on the specified library. Parsed outputs do not persist.

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

Request

Specifies the library to use when instant parsing the given file.

required	object (DocumentIdentifier)
libraryId required	string (CogniteExternalId) <= 255 characters The external ID of a library for parsing

Responses

200

Temporary diagram entity detections in a given file based on the provided library.

400

The response for a failed request.

post/diagram-parsing/parsing/instant

Request samples

application/json

{"document": {"fileId": {"space": "string",
"externalId": "my.known.id"
},
"pageNumber": 0
},
"libraryId": "my.known.id"
}

Response samples

application/json

{"entities": [{"externalId": "my.known.id",
"pathIds": ["string"
],
"symbolId": "my.known.id"
}
],
"message": "string",
"status": "Failed"
}