Get job result

This call blocks until the result is available. If blocking is not acceptable, getJobInfo can be polled, until the job's status is completed.

If the job has completed successfully, its result data, typically documents, can be retrieved using the getJobResultData request.

Note that when waiting for the job result, request timeouts may occur after 2 minutes. Therefore, it is recommended to handle request timeouts, especially for long-running jobs or for services under high load.

Path Parameters

jobId string required

The job ID as returned by createJob.

Responses

• 200
• 404
• 409

---

Successful response to the getJobResult request

application/json

application/xml

Schema

Example (from schema)

---

Schema

status string required

Possible values: [success, warning, error]

Whether the job has been processed successfully.

Successful jobs typically have dataList, otherwise the property error contains a description of the error.

error object
code errorCode required
Possible values: [internal, external, configuration, generic, unsupportedFormat, unsupportedFeature, option, canceled, timeout, password, conformance, corrupt]
message string required
events event[]
List of processing events.
Depending on the severity, different actions are recommended:
• info: Event is of a strictly informational nature and can be ignored. If a verbose processing log is written, such events can be included.
• warning: This event is a critical conversion warning that should be handled.
• error: Such an event occurs only in failed jobs and contains error information additional to the job result info's error property.
Array [
code eventCode required
Possible values: [ExternalResourceUnavailable, ContentClipped, ContentOverflow, ContentRasterized, PageRenderer, VisualDifferences, Colorants, LayersRemoved, TransparencyRemoved, MetadataRemoved, CorruptionRepaired, SignatureRemoved, ContentRecovered, FontSubstituted, AnnotationRemoved, MultimediaRemoved, ActionRemoved, StructureRemoved, PartialExtraction, NotLinearized, OcrIncomplete, UnicodesIncomplete, TaggingIncomplete, Event, ChildRemoved]
severity severity required
Possible values: [info, warning, error]
dataId dataId
Unique ID of the data.
This ID is returned by addData and can be used to associate events and messages to specific input data. Therefore it is highly recommended to log the data ID in the client log file.
dataPart string
The part of the data that is affected, e.g. an embedded file or attachment.
message string required
]
dataList data[]
Array [
fileName string required
size integer required
resultId resultId required
Unique ID that can be used to retrieve the result data using getJobResultData.
properties object[] required
Array [
name string required
Name of the property
value string required
Value of the property
]
]

{
  "status": "success",
  "error": {
    "code": "internal",
    "message": "string"
  },
  "events": [
    {
      "code": "ExternalResourceUnavailable",
      "severity": "info",
      "dataId": "string",
      "dataPart": "string",
      "message": "string"
    }
  ],
  "dataList": [
    {
      "fileName": "string",
      "size": 0,
      "resultId": "string",
      "properties": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Schema

Example (from schema)

---

Schema

status string required

Possible values: [success, warning, error]

Whether the job has been processed successfully.

Successful jobs typically have dataList, otherwise the property error contains a description of the error.

error object
code errorCode required
Possible values: [internal, external, configuration, generic, unsupportedFormat, unsupportedFeature, option, canceled, timeout, password, conformance, corrupt]
message string required
events event[]
List of processing events.
Depending on the severity, different actions are recommended:
• info: Event is of a strictly informational nature and can be ignored. If a verbose processing log is written, such events can be included.
• warning: This event is a critical conversion warning that should be handled.
• error: Such an event occurs only in failed jobs and contains error information additional to the job result info's error property.
Array [
code eventCode required
Possible values: [ExternalResourceUnavailable, ContentClipped, ContentOverflow, ContentRasterized, PageRenderer, VisualDifferences, Colorants, LayersRemoved, TransparencyRemoved, MetadataRemoved, CorruptionRepaired, SignatureRemoved, ContentRecovered, FontSubstituted, AnnotationRemoved, MultimediaRemoved, ActionRemoved, StructureRemoved, PartialExtraction, NotLinearized, OcrIncomplete, UnicodesIncomplete, TaggingIncomplete, Event, ChildRemoved]
severity severity required
Possible values: [info, warning, error]
dataId dataId
Unique ID of the data.
This ID is returned by addData and can be used to associate events and messages to specific input data. Therefore it is highly recommended to log the data ID in the client log file.
dataPart string
The part of the data that is affected, e.g. an embedded file or attachment.
message string required
]
dataList data[]
Array [
fileName string required
size integer required
resultId resultId required
Unique ID that can be used to retrieve the result data using getJobResultData.
properties object[] required
Array [
name string required
Name of the property
value string required
Value of the property
]
]

<root>
  <status>success</status>
  <error>
    <code>internal</code>
    <message>string</message>
  </error>
  <events>
    <code>ExternalResourceUnavailable</code>
    <severity>info</severity>
    <dataId>string</dataId>
    <dataPart>string</dataPart>
    <message>string</message>
  </events>
  <dataList>
    <fileName>string</fileName>
    <size>0</size>
    <resultId>string</resultId>
    <properties>
      <name>string</name>
      <value>string</value>
    </properties>
  </dataList>
</root>

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 no result, e.g. because it has not yet been started.

Loading...