Run parsing with tag detection for files

A parsing job will be started on the files to detect their entities and connections and map assets.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
project
required
string

The CDF project name, equal to the project variable in the server URL.

Example: publicdata
Request Body schema: application/json
required

Defines parsing options needed for symbol and tag detection jobs.

required
Array of objects (DocumentIdentifier) [ 1 .. 100 ] items
required
object (DetectTagsResourceFilter)

Map of filters for DMS list operations used to load assets and files

required
object (ExternalId)

The externalId of a library to use for parsing

minTokens
integer

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.

nonce
required
string

Session nonce value

partialMatch
boolean

Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.

searchField
string

This field determines the string to search for and to identify object entities.

Responses
200

List of external IDs returned in a response

400

The response for a failed request.

post/api/v1/projects/{project}/diagram-parsing/parsing/full
Request samples
application/json
{
  • "documents": [
    • {
      }
    ],
  • "filters": {
    • "Asset": { },
    • "File": { }
    },
  • "libraryId": {
    • "externalId": "my.known.id"
    },
  • "minTokens": 0,
  • "nonce": "string",
  • "partialMatch": true,
  • "searchField": "string"
}
Response samples
application/json
{
  • "items": [
    • "my.known.id"
    ]
}
➔ Next to Libraries / Copy library