Get job info

Get job info

Path Parameters

• jobId string required

  The job ID as returned by createJob.

Responses

• 200
• 404

---

Successful response to the createJob and getJobInfo requests

application/json

• Schema
• Example (from schema)

---

Schema

• jobId string

  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

  code string

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

  message string

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

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

application/xml

• Schema
• Example (from schema)

---

Schema

• jobId string

  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

  code string

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

  message string

  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>

The job with the specified ID could not be found.

application/problem+json

• Schema
• Example (from schema)
• Job Not Found Json

---

Schema

• type string

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

• title string

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

• status string

  The HTTP status code.

• detail string

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

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

{
    "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
• Example (from schema)
• Job Not Found Json

---

Schema

• type string

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

• title string

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

• status string

  The HTTP status code.

• detail string

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

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

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