List all jobs

GET 
/jobs/

List all jobs and their statuses.

Responses

200

Successful response to the listJobs request

application/json

Schema

Schema

• Array [

jobId jobId (string)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 (string)required

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

message stringrequired

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

• ]

Example (from schema)

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

application/xml

Schema

Schema

• Array [

jobId jobId (string)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 (string)required

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

message stringrequired

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

• ]

Example (from schema)

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

Loading...