Detect annotations in engineering diagrams

Required capabilities: assetsAcl:READ filesAcl:READ

Detect annotations in engineering diagrams. Note: All users in a CDF project with assets read-all and files read access to the requested files can access data sent to this endpoint. Supported input file mime_types are application/pdf, image/jpeg, image/png, image/tiff. Also note that the header of a successful response contains an X-Job-Token which allows to fetch the result of the job at /context/diagram/detect/{jobId} without requiring 'assetsAcl:READ'.

Asset-centric support in this endpoint is deprecated. This covers referencing files by fileId or fileExternalId and the assetsAcl:READ requirement for retrieving results. Reference files with fileInstanceId, pass entities from your data model, and store results in the core data model instead of with the Annotations API. See Deprecated and retired features for details and timelines.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required
Array of objects or objects or objects (FileReferenceWithPageRange) [ 1 .. 50 ] items

Files to run entity detection on.

entities
required
Array of objects (DiagramDetectEntities) [ 1 .. 500000 ] items

A list of entities to look for. For example, all the assets under a root node. The searchField determines the strings that identify the entities.

searchField
string (DiagramSearchField)

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

partialMatch
boolean (DiagramPartialMatch)

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

minTokens
integer (DiagramMinTokens)

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.

Responses
200

Success

400

The response for a failed request.

post/context/diagram/detect
Request samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "entities": [
    • {
      },
    • {
      }
    ],
  • "searchField": "userDefinedField",
  • "partialMatch": false,
  • "minTokens": 2
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "jobId": 123,
  • "status": "Queued",
  • "createdTime": 1730204346000,
  • "startTime": 1730204346000,
  • "statusTime": 1730204346000,
  • "errorMessage": null,
  • "searchField": "userDefinedField",
  • "partialMatch": false,
  • "minTokens": 2
}
➔ Next to Get the results for converting an engineering diagram to an image