Introduction

The Process Manager implements an internal REST API that allows you to verify its status and monitor its operations:

Available URLs

GET /processTypes

Retrieves a list of valid process types. This list will correspond with the types of workers which have been attached to this instance of the Process Manager and can be used to verify that worker has been able to connect and register its process type with the Process Manager.

Successful Response

Response Body

JSON object with the following property:

• processTypes (Array) A list of registered process types. Each member of the array will be an object with the following properties:
  • type (String) The identifier for the type of process registered.
  • expirationDateTime (String) A Date/Time string which denotes the time at which the process type will no longer be valid.

GET /processes

Retrieves a list of completed and ongoing processes which have been created through the Process Manager's public API. This endpoint can be used to verify the status of processes, or to locate the id of a process if it is lost.

Successful Response

JSON object with the following property:

• processes (Array) A list of created processes. Each member of the array will be an object with the following properties:
  • id (String) A unique identifier used to retrieve the status of this particular process.
  • tenantId (String) An identifier which indicates the source of the request that created the process.
  • type (String) The identifier for the type of process requested.
  • state (String) The current state of the process. It will be one of the following values:
    • "processing" - The OCR process is in progress.
    • "complete" - The OCR process is completed.
    • "error" - The OCR process returns an error.
  • creationDateTime The time at which the process was created.
  • expirationDateTime The time at which the process manager will no longer store the details of this process.
  • attempts The number of times the Process Manager has attempted to dispatch this process to a worker for processing.