Get job info

GET 
/jobs/:jobId

Get job info

Request

Path Parameters

jobId stringrequired

The job ID as returned by createJob.

Responses

200

Successful response to the createJob and getJobInfo requests

application/json

Schema

Schema

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

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)

<root>
  <jobId>string</jobId>
  <status>
    <code>creating</code>
    <message>string</message>
  </status>
</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 stringrequired

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": "string",
  "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 stringrequired

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>string</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>

Loading...