Create new job

Create a new job to be processed with the given workflow and profile. After the job has been created, data (typically documents) can be added using the addData request.

All created jobs should be deleted using the deleteJob request.

Query Parameters

workflow string
The name of the workflow.
If no workflow is specified, the default workflow of the service is used.
Example: Archive PDF/A-2
profile string
The name of the profile.
If no profile is specified, the default profile of the workflow is used.
Example: default
name string

The name of the job.

This value may be used by the workflow, e.g. to name the output file when merging multiple inputs.

application/json

application/xml

Request Body

Body of the createJob request

• 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.

• ]

Request Body

Body of the createJob request

• 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.

• ]

Responses

• 201
• 400
• 415
• 503

---

Successful response to the createJob and getJobInfo requests

application/json

application/xml

Schema

Example (from schema)

---

Schema

jobId jobId required

Unique ID of the job.

The job ID can be used to control the job, e.g. start it, as well as identify corresponding messages in the service log file. Therefore it is highly recommended to log the job ID in the client log file.

status object required

code jobStatusCode required

Possible values: [creating, pending, processing, completed]

message string required

A message describing the job's status in more detail. Example: "Converting 'input.pdf' to PDF/A."

{
  "jobId": "string",
  "status": {
    "code": "creating",
    "message": "string"
  }
}

Schema

Example (from schema)

---

Schema

jobId jobId required

Unique ID of the job.

The job ID can be used to control the job, e.g. start it, as well as identify corresponding messages in the service log file. Therefore it is highly recommended to log the job ID in the client log file.

status object required

code jobStatusCode required

Possible values: [creating, pending, processing, completed]

message string required

A message describing the job's status in more detail. Example: "Converting 'input.pdf' to PDF/A."

<root>
  <jobId>string</jobId>
  <status>
    <code>creating</code>
    <message>string</message>
  </status>
</root>

• Request could not be parsed
• The options are not valid JSON
• The requested workflow or profile does not exist

application/problem+json

application/problem+xml

Schema

Example (from schema)

---

Schema

type string

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

title string required

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

status integer required

The HTTP status code.

detail string required

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

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

Schema

Example (from schema)

---

Schema

type string

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

title string required

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

status integer required

The HTTP status code.

detail string required

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

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

The content type is neither application/json nor application/xml

Too many jobs.

application/problem+json

application/problem+xml

Schema

Example (from schema)

---

Schema

type string

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

title string required

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

status integer required

The HTTP status code.

detail string required

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

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

Schema

Example (from schema)

---

Schema

type string

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

title string required

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

status integer required

The HTTP status code.

detail string required

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

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

Loading...