Start job

POST 
/jobs/:jobId:start

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.

Request

Path Parameters

jobId stringrequired

The job ID as returned by createJob.

Responses

204

The job has been started successfully

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>

409

The job has already been started or canceled.

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

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>

Loading...