pdfToolbox in the cloud- preflight_vars

Retrieve variable keys from a pdfToolbox profile.

Required parameters

  • profile: the pdfToolbox profile to retrieve variable definitions from
    • example: https://s3.eu-central-1.amazonaws.com/ccapi-sample/sample.kfpx
    • the URLs of all predefined Profiles can be found in the article: Predefined Profiles
    • type: url
    • mandatory: true

Data example

preflight_vars.json

Usage Example 

curl -X POST https://api.callassoftware.io/v1/pdfToolbox/preflight_vars -H 'x-api-key: your-api-key' -d @preflight_vars.json
Click to copy

The preflight_vars operation produces exactly three result files

  • about.json: contains general information about the specified profile
  • definitions.json: contains commented information about the contained variables
  • vars.json: can be used directly in the vars field of the preflight operation
about.json
definitions.json
vars.json

Response and Error codes

  • 200: operation completed (retrieve result files from the result_url field)
    • description": the result_url field points to a .json file containing the produced files
    • state: COMPLETED
    • progress: 100
    • result_url: https://a_server/some_sub_folder/a_json_file_containing_the_resulting_urls
  • 202: operation pending (keep going using a GET on the belonging path ...)
    • description: processing has not finished yet. it is essential to wait until one of the final HTTP states is reached (such as HTTP/200 or HTTP/4xx or HTTP/5xx). The state and progress fields can be used to indicate progress
    • state: PROCESSING
    • progress: 10
  • 4xx: a client error has occurred
  • 5xx: a server error has occurred