Skip to main content

Add data to job

Add data (typically a document) to the job. The data is processed immediately by the workflow.

Use the startJob request to signal that all data has been added to the job.

Note that the query parameter "url" must be used in conjunction with the "application/json" or "application/xml" content.

Path Parameters
    jobId string required

    The job ID as returned by createJob.

Query Parameters
    url string

    The HTTP(S) URL where the file can be downloaded.

    If this parameter is used, the Content-Type must be application/json or application/xml and contain only the options.

Request Body required
    options option[]

    List of processing options

    Options can either be set as job options in createJob or data specific options in addData. Data specific options are used to process the respective data and override job options of the same name. It is recommended to use job options whenever possible.

    Unless documented otherwise, each option must be set only once.

  • Array [
  • name string required

    Option name

    The list of supported options depends on the profile used. Common names are:

    • DOC.PASSWORD: Password used for password protected files. This option can be added multiple times, where all passwords are tried. The list of passwords is also used to open embedded and/or attached files.
    value string required

    The option's value.

    Note that the value must match the type required by the option. Otherwise workflow processing will abort with an error code option.

  • ]
  • data binary required

    The file/data to be appended to the job.

    The Content-Disposition header must contain either the filename or the filename* parameter. It is recommended to set a filename with an extension. Alternatively the MIME type of the data is used to determine its type.

    The query parameter "url" is ignored if multipart/form-data content is used.


Successful response to the addData request

    dataId dataId required

    Unique ID of the data.

    This ID is returned by addData and can be used to associate events and messages to specific input data. Therefore it is highly recommended to log the data ID in the client log file.