curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": {
"externalId": "my.known.id"
},
"nonce": "<string>",
"minTokens": 123,
"partialMatch": true,
"searchField": "<string>"
}
'{
"items": [
"my.known.id"
]
}Required capabilities:
DiagramParsingAcl:WRITEDataModelInstancesAcl:WRITE
A parsing job will be started on the files to detect their entities and connections and map assets.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"filters": {
"Asset": {},
"File": {}
},
"libraryId": {
"externalId": "my.known.id"
},
"nonce": "<string>",
"minTokens": 123,
"partialMatch": true,
"searchField": "<string>"
}
'{
"items": [
"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.
The CDF project name, equal to the project variable in the server URL.
"publicdata"
Defines parsing options needed for symbol and tag detection jobs.
1 - 100 elementsShow child attributes
Map of filters for DMS list operations used to load assets and files
Show child attributes
The externalId of a library to use for parsing
Show child attributes
Session nonce value
Each detected item must match the detected entity on at least this number of tokens. A token is a substring of consecutive letters or digits.
Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.
This field determines the string to search for and to identify object entities.
List of external IDs returned in a response
1 - 100 elementsThe external ID provided by the client. Must be unique for the resource type.
255Was this page helpful?