Platform Jobs

Overview

A platform job is a standard and repeatable process that manages, transforms, or writes data on the Intelligent Risk Platform. Such jobs may consist of multiple subprocesses that are performed in a specific sequence —in a pipeline— by which the output of one step is used in the next step of the process.

Such jobs tend to be rather long-running (time-consuming) and thereby pose a problem for RESTful APIs as long-running processes can be blocking.

Standard jobs

A standard job is a system-defined process that manages processes that are typically time-consuming and expensive. These processes include the creation of the core objects, the import or export of data, and catastrophe modeling.

Platform APIs expose operations that enable tenants to define and initiate jobs. Each Intelligent Risk Plaform API collects job management and tracking resources together.

  • Risk Data API uses jobs to manage catastrophe modeling processes.
  • Import API jobs uses jobs to manage the import of exposure data into the IRP.
  • Export API uses jobs to manage the export of exposure data from the IRP.
  • Geohaz API uses jobs to manage the geocoding and hazarding of exposures.
  • Model API uses jobs to manage the creation of ALM, DLM, and HD models.
  • Grouping API uses jobs to manage the grouping of analysis results data.

Tracking Job Statuses

Each Platform API exposes distinct resources for tracking the status of API jobs.

A successful response returns the job object, which provides detailed information about this job including the submitTime, startTime, type, job details, and its status:

StatusDefinition
PENDINGThe job is pending. Follow by the QUEUED status.
QUEUEDThe job has been added to the queue. Follow by the RUNNING status.
RUNNINGThe platform is processing the job. Follow by the FINISHED or FAILED status.
FINISHEDThe job is finished.
FAILEDThe job has failed.
CANCEL_REQUESTEDThe platform has received a request to canel the job. Follow by the CANCELLING status.
CANCELLINGThe platform is cancelling the job. Follow by the CANCELLING status.
CANCELLEDThe job has been cancelled.

📷

NOTE

  • Some operations enable you to initiate multiple types of jobs. For example, the Create Import Job operation may initiate either a CEDE_IMPORT , MRI_IMPORTand other import job types depending on the values specified in the request body.