Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • auth - application id associated with the partner (not require if wrapped into api token)

  • userId - partner defined user id of the user that is calling the editor url - mandatory to pass to facility counting of distinct users

File Conversion / Export (On-premise version only)
Note: file conversion can be achieve also with SaaS version by running appropriate commands from script, see PDF / Image Creation and Format Conversion

  • outputPath - optional path to store resulting file(s) like script output and all files generated by the script (e.g. an exported pdf file); if not specified the files are written to current working directory

  • fileType - PDF (coming soon with , since 1.151: DWG, DXF, PNG, SVG, BMP, JPG)

  • dwgVersion - 2018, R32, 2013, R27, 2010, R24, 2007, R21, 2004, R18, 2000, R15 (only for DWG and DXF)

Scripts

  • script - Url http(s) url of the script file (Saas: mandatory; On-premise: if specified fileType is ignored)

  • scriptOutputFile - It specifies the filename where the script output is written to (optioanl; SaaS: The file is also uploaded to partner S3 content bucket logs folder)

...

  • storageBucket - it specifies designated output S3 bucket where the resulting file(s) like script output and all files generated by the script are uploaded to (if not specified the default S3 content bucket that is associated with your application identifier is used)

  • storageBucketRegion - region the storageBucket is located in

Note for SaaS: Instead of passing all parameters individually, you can enclose the parameters in a generated apitoken that will be passed as a single “apitoken” query parameter (see Token Authentication).

Response

Text: JobID::{jobId}

...