Store job result data
Store the result data by sending it to a Webserver via HTTP(S) request.
Path Parameters
- jobId string required
The job ID as returned by
createJob
. - resultId string required
The result data's ID as returned by
getJobResult
. - storeMethod string required
Possible values: [
put
,post
]The HTTP method used to store the result.
Query Parameters
- url string required
The HTTP(S) URL where the file can be stored.
- 204
- 400
- 404
- 409
The result has been stored successfully.
- The provided HTTP method is not valid.
- The query parameter "url" is missing.
- The provided URL is invalid (not a "http(s):" URL).
- The file could sent to the provided URL.
- 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
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"
}
- Schema
- Example (from schema)
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>
The job or result with the specified ID could not be found.
- application/problem+json
- 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.
{
"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)
- 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>
Unable to get result data, e.g. because it is not yet available. Call getJobResult
first.