Add data to job

POST 
/jobs/:jobId/data/

Add data such as documents, images, and other accepted files for processing.

Use the query parameter "url" with the "application/json" or "application/xml" content.

When you add document options, follow the correct JSON structure. Example: Using the DOC.PASSWORD option:

[
  {
    "name": "DOC.PASSWORD",
    "value": "Replace with your password as a string."
  }
]

After you add all data to the job and send the addData request, send the startJob API request.

Request

Path Parameters

jobId stringrequired

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.

multipart/form-data

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 stringrequired

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 stringrequired

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 binaryrequired

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.

application/json

Body

required

• Array [

name stringrequired
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 stringrequired

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.

• ]

application/xml

Body

required

• Array [

name stringrequired
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 stringrequired

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.

• ]

Responses

201

Successful response to the addData request

application/json

Schema

Schema

dataId dataId (string)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.

Example (from schema)

{
  "dataId": "string"
}

application/xml

Schema

Schema

dataId dataId (string)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.

Example (from schema)

<dataId>string</dataId>

400

• Request could not be parsed

• The data is missing

• The data's filename is missing

• The options are not valid JSON/XML

• The file could not be downloaded from the provided URL.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

404

The job with the specified ID could not be found.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

jobNotFoundJson

{
    "type": "http://www.pdf-tools.com/service/rest/errors/jobNotFound",
    "title": "Job not found.",
    "detail": "The job with ID 'job_XYZ' could not be found",
    "status": 404
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

jobNotFoundJson

<problem xmlns="urn:ietf:rfc:7807">
  <type>http://www.pdf-tools.com/service/rest/errors/jobNotFound</type>
  <title>Job not found.</title>
  <detail>The job with ID 'job_XYZ' could not be found</detail>
  <status>404</status>
</problem>

409

The job has already been started or canceled.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

415

• The content type is not multipart/form-data, application/json or application/xml

• The content type of the options field in the multipart/form-data content is not application/json

Loading...