Convert a diagram to image format

Convert interactive engineering diagrams to image format, with highlighted annotations. Supported input file mime_types are application/pdf, image/jpeg, image/png, image/tiff. Supported output image formats are PNG and SVG, only the svg embeds the input annotations.

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 (DiagramConvertRequestSchema) [ 1 .. 50 ] items

An array of files and annotations to create interactive diagrams.

grayscale
boolean (Grayscale)

Return the SVG version in grayscale colors only (reduces the file size).

Responses
200

Success

400

The response for a failed request.

post/context/diagram/convert
Request samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "grayscale": true
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "jobId": 123,
  • "status": "Queued",
  • "createdTime": 1730204346000,
  • "startTime": 1730204346000,
  • "statusTime": 1730204346000,
  • "errorMessage": null,
  • "grayscale": true
}
➔ Next to Detect annotations in engineering diagrams