The EPISHIP Job States API provides a mechanism to monitor and control long-running asynchronous processes initiated within the platform. You can develop applications that track the progress of report generation, bulk exports, or complex data processing tasks, ensuring users have real-time visibility into operation status.
View Doc →
The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and the Job Queue system.
Figure 1. EPISHIP API relationship diagram. Asynchronous job execution and status polling flow.
EPISHIP’s interface utilizes job states to provide user feedback for tasks that are not instantaneous. This allows users to initiate a heavy operation (like a large report export) and continue working while the system processes the request in the background.
The REST API that exposes the status, progress, and metadata of background jobs. It allows client applications to poll for updates and attempt to cancel jobs that are pending or in progress.
Secured via Bearer tokens. Access to job states is restricted to the user or company that initiated the job, ensuring that sensitive operational data remains private.
Jobs transition through various states such as `queued`, `processing`, `completed`, or `failed`. The API provides detailed timestamps (`executed_at`, `finished_at`) and progress percentages to accurately reflect the job’s current standing.
Users can use the EPISHIP Job States API to perform common workflows, such as:
Job State properties available to view and filter through the EPISHIP Job States API:
