Skip to main content

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

Successful response to the getJobResult request

Schema
  • status string

    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 string

    Possible values: [internal, configuration, generic, unsupportedFormat, unsupportedFeature, option, canceled, timeout, password, conformance, corrupt]

  • message string
  • 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.
  • code string

    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 string

    Possible values: [info, warning, error]

  • dataId string

    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
  • dataList data[]
  • fileName string
  • size integer
  • resultId string

    Unique ID that can be used to retrieve the result data using getJobResultData.

  • properties object[]
  • name string

    Name of the property

  • value string

    Value of the property

Loading...