Delete job
DELETE/jobs/:jobId
Delete the job and all associated resources. It is recommended to delete all jobs that have been created. Jobs that are not deleted explicitly are deleted automatically after a timeout or when the service is shut down.
A job can be deleted regardless of its status.
If the status is processing, it is canceled automatically before deletion.
Request
Path Parameters
The job ID as returned by createJob.
Responses
- 202
- 204
- 404
The job will be deleted as soon as processing has finished.
The job has been deleted successfully
The job with the specified ID could not be found.
- application/problem+json
- application/problem+xml
- Schema
- Example (from schema)
- jobNotFoundJson
Schema
A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.
A short, human-readable summary of the problem type.
The HTTP status code.
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
}
- Schema
- Example (from schema)
- jobNotFoundJson
Schema
A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.
A short, human-readable summary of the problem type.
The HTTP status code.
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>