Skip to main content

Get job result

GET 

/jobs/:jobId/result

This request returns result when it is available and is blocked otherwise. You can also call the getJobInfo API request until the returned job status is completed.

When the job is completed successfully, retrieve the result data with the getJobResultData API request.

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

Request

Path Parameters

    jobId stringrequired

    The job ID as returned by createJob.

Responses

Successful response to the getJobResult request

Schema

    status stringrequired

    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 (string)required

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

    message stringrequired

    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 (string)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 (string)required

    Possible values: [info, warning, error]

    dataId 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 stringrequired
  • ]

  • dataList

    data[]

  • Array [

  • fileName stringrequired
    size integerrequired
    resultId resultId (string)required

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

    properties

    object[]

    required

  • Array [

  • name stringrequired

    Name of the property

    value stringrequired

    Value of the property

  • ]

  • ]

Loading...