Start job

Signal that all data has been added to a job. Documents are processed immediately after they have been added. The startJob request activates the subsequent document merge and post processing steps.

After starting a job, its result can be awaited using the getJobResult request.

Path Parameters

jobId string required

The job ID as returned by createJob.

Responses

• 204
• 404
• 409

---

The job has been started successfully

The job with the specified ID could not be found.

application/problem+json

application/problem+xml

Schema

Example (from schema)

jobNotFoundJson

---

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"
}

{
    "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
}

Schema

Example (from schema)

jobNotFoundJson

---

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>

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

The job has already been started or canceled.

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