GetProcessingStatus

Description

Returns the status of a processing job. The status can be "Completed", "EnrichmentProcessingFailed" or "Failed". If the job is still pending processing, then the process status will be "Pending".

"Completed" status - The whole processing is successful. The Ripper processed the PDF, imported the links and ran the Enrichment Automation (if such was provided) successfully.

"EnrichmentProcessingFailed" status - The Ripper failed to import the links or run the Enrichment Automation, or failed to do both.

"Failed" status - The Ripper failed to process the PDF and therefore links cannot be imported and the Enrichment Automation cannot be run.

Parameters

Name
Value

jobGuid

The Guid of the processing job to get status for

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<result>
  <code>
    <![CDATA[ SUCCESS ]]>
  </code>
  <message>
    <![CDATA[ Status retrieved successfully. ]]>
  </message>
  <data>
    <ProcessStatus>
      <![CDATA[ Completed ]]>
    </ProcessStatus>
  </data>
</result>

Return Codes

  • SUCCESS

  • ERROR

Last updated