Store job result data

POST 
/jobs/:jobId/result/:resultId::storeMethod

Store the result data by sending it to a Webserver via HTTP(S) request.

Request

Path Parameters

jobId stringrequired

The job ID as returned by createJob.

resultId stringrequired

The result data's ID as returned by getJobResult.

storeMethod stringrequired

Possible values: [put, post]

The HTTP method used to store the result.

Query Parameters

url stringrequired

The HTTP(S) URL where the file can be stored.

Responses

204

The result has been stored successfully.

400

• 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

Schema

Schema

typestring

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

titlestringrequired

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

statusstringrequired

The HTTP status code.

detailstringrequired

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

typestring

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

titlestringrequired

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

statusstringrequired

The HTTP status code.

detailstringrequired

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>

404

The job or result with the specified ID could not be found.

application/problem+json

Schema

Schema

typestring

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

titlestringrequired

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

statusstringrequired

The HTTP status code.

detailstringrequired

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

typestring

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

titlestringrequired

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

statusstringrequired

The HTTP status code.

detailstringrequired

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

Unable to get result data, e.g. because it is not yet available. Call getJobResult first.