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.
Job operations
The table lists operations that define jobs and the job types created by those operations. Some operations can initiate different types of jobs depending on the parameters specified in the request.
API | Operation | Job Type |
---|---|---|
Accumulation API | Create Accumulation Job | |
Clone API | Create Clone Job | |
Copy API | Create Copy Job | |
Currency Conversion API | Create Currency Conversion Job | |
Enrich Exposure API | Create Enrich Exposure Job | |
Export API | Create Export Job | |
Geohaz API | Create Geohaz Job | |
Grouping API | Create Grouping Job | |
Import API | Create Import Job | |
Model API | Create Model Job | |
Rollup API | Create Rollup Job | |
STEP API | Create STEP Job | |
Variation API | Create Variation Job |
Job types
Job Type | Operation |
---|---|
ALM | |
ALM_IMPORT | |
BATCH | |
BULK_EDIT | |
CEDE_IMPORT | |
CLIMATE_CHANGE | |
CONFIGURE_DLM | |
CONVERT_ACCOUNT_CURRENCY | |
CONVERT_AGGREGATE_PORTFOLIO_CURRENCY | |
CONVERT_EVENT_RATE_LOSS | |
CONVERT_PORTFOLIO_CURRENCY | |
CONVERT_RESULT_CURRENCY | |
CONVERT_TREATY_CURRENCY | |
COPY_ACCOUNT | |
COPY_AGGPORT | |
COPY_PORTFOLIO | |
CREATE_EDM | |
DELETE_ACCOUNT | |
DELETE_AGGREGATE_PORTFOLIO | |
DELETE_EDM | |
DELETE_PORTFOLIO | |
DELETE_RDM | |
DEREGISTER_DATA_BRIDGE_EDM | |
DLM DEPRECATED | |
DOWNLOAD_EDM | Create Export Job |
DOWNLOAD_LOCATION_RESULTS | Create Export Job |
DOWNLOAD_RDM | Create Export Job |
DOWNLOAD_REPORT | |
DOWNLOAD_RESULTS | Create Export Job |
EDM2EDM | Create Export Job |
EDM_UPGRADE | |
ENRICH_EXPOSURE | |
EXPOSURE_BATCHES | |
EXPOSURE_BATCH_EDIT | |
EXTRACT_ELT | |
GEOCODING | |
GEOHAZ | |
GROUPING | |
GROUP_JOBTYPE_REGROUP | |
GROUPING_LOSS_POSTPROCESSOR | |
HAZARD | |
HD | |
HD_ALM | |
HD_ALM_GROUPING | |
HD_ENGINE | |
HD_GROUPING | |
MAP_PERSECTIVE | |
MARGINAL_IMPACT | |
MRI_IMPORT | |
OED_IMPORT | |
PATE | |
PROCESS_RDM | |
REGISTER_DATA_BRIDGE_EDM | |
RENAME_ANALYSIS | |
REPORT_GENERATION | |
RERUN_EP | |
RESTORE_ARCHIVE | |
SIMULATE_LOSSES | |
SIMULATION | |
STOCHASTIC_CEP | |
UDW_POSTPROCESSOR | |
UPDATE_RESULTS_COUNT | |
UPLOAD_EDM | |
UPLOAD_RDM |
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:
Status | Definition |
---|---|
PENDING | The job is pending. Follow by the QUEUED status. |
QUEUED | The job has been added to the queue. Follow by the RUNNING status. |
RUNNING | The platform is processing the job. Follow by the FINISHED or FAILED status. |
FINISHED | The job is finished. |
FAILED | The job has failed. |
CANCEL_REQUESTED | The platform has received a request to canel the job. Follow by the CANCELLING status. |
CANCELLING | The platform is cancelling the job. Follow by the CANCELLING status. |
CANCELLED | The 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_IMPORT
and other import job types depending on the values specified in the request body.- Some operations enable you to initiate multiple types of jobs. For example, the Import Exposures from File operation may initiate either an
ALM_IMPORT
orMRI_IMPORT
job depending on the values specified in the request body.
Updated about 2 months ago