WorkflowsV1

Intelligent Risk Platform employs a workflow engine to manage expensive and time-consuming processes. These processes include the creation of core objects, catastrophe analysis, and importing or exporting of data from the platform.

Resources that initiate jobs do not immediately return data. Rather, they return a 202 Accepted response code when the job is created and added to the workflow engine queue. The Intelligent Risk Plaform manages these jobs asynchronously: it does require that that connections to persist until the process is completed and may accept new requests while another job is being processed.

Risk Modeler API supports two types of workflow jobs:

  • A standard workflow is a system-defined process that the Intelligent Risk Platform manages as a workflow job on the workflow engine.
  • A custom workflow is a user-defined workflow that defines a series of jobs and subprocesses called operations that are processed by the work engine in a pipeline.

Workflow job statuses

The 202 Accepted response code indicates that a request has been accepted for processing, and that the Intelligent Risk Platform has added a workflow job to workflow engine queue, and provides the client with a means of tracking the status of the workflow job.

The Intelligent Risk Platform does not notify the client when the workflow job is complete. Rather, operations that return the workflowId of the job enabling the client to track the progress of the workflow job. You can use the workflowId returned to track the status of a job using the Get Workflow or Operation resource.

StatusDescription
QUEUEDIndicates that the workflow engine has created the job and added it to the queue for processing.
PENDINGIndicates that the workflow engine is about to be processed.
RUNNINGIndicates that the workflow engine is processing the job.
FINISHEDIndicates that the workflow engine has finished processing the job.
FAILEDIndicates that the job has failed.
CANCEL_REQUESTEDIndicates that the client has requested that the workflow engine cancel job using the Cancel Job resource.
CANCELLINGIndicates that the workflow engine is cancelling the job.
CANCELLEDIndicates that the job has been cancelled.

Standard job types

A standard job is a system-defined process that the Intelligent Risk Platform manages as a workflow job on the workflow engine.

JobResources
ALMPOST v2/exposurebatches, POST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process
ALM_IMPORT[POST v1/imports]
BULK_EDITPOST v1/globaledit
CLIMATE_CHANGEPOST /v1/analyses/{id}/climate-change, POST /v2/analyses/{id}/climate-change
CONFIGURE_DLMDEPRECATED POST v1/accounts/{id}/process, POST v2/accounts/{id}/process, DEPRECATED POST v1/portfolios/{id}/process, POST v2/portfolios/{id}/process, POST v1/exposurebatches, POST v2/exposurebatches
CONVERT_ACCOUNT_CURRENCYPOST v1/accounts/{id}/convertcurrency, POST v2/accounts/{id}/convertcurrency
CONVERT_AGGREGATE_PORTFOLIO_CURRENCYPOST v1/aggregate-portfolios/{id})/convertcurrency, POST v2/accounts/{id}/convertcurrency, POST v2/aggregate-portfolios/{id}/convertcurrency, POST v2/accounts/{id}/convertcurrency
CONVERT_EVENT_RATE_LOSSPOST v1/analyses/{id}/convert-event-rate-loss, POST v2/analyses/{id}/convert-event-rate-loss
CONVERT_PORTFOLIO_CURRENCYPOST v1/portfolios/{id}/convertcurrency,POST v2/portfolios/{id}/convertcurrency
CONVERT_RESULT_CURRENCYPOST v1/analyses/{id}/convertcurrency, POST v2/analyses/{id}/convertcurrency
CONVERT_TREATY_CURRENCYPOST v1/treaties/{id}/convertcurrency
COPY_ACCOUNTPOST v1/accounts/{id}/copy, POST v2/accounts/{id}/copy
COPY_AGGPORTPOST v1/aggregate-porfolios/{id}/copy, POST v2/aggregate-porfolios/{id}/copy
COPY_PORTFOLIOPOST v1/portfolios/{id}/copy, POST v2/portfolios/{id}/copy
CREATE_EDMPOST v1/datasources
DELETE_ACCOUNTDELETE v1/accounts/{id}, DELETE v2/accounts/{id}
DELETE_AGGREGATE_PORTFOLIODELETE v1/aggregate-porfolios/{id}, DELETE v2/aggregate-portfolios/{id}
DELETE_EDMDELETE v1/datasources/{datasourcename}
DELETE_PORTFOLIODELETE v1/portfolios/{id}, DELETE v2/portfolios/{id}
DELETE_RDMPOST v1/exports, POST v2/exports
DEREGISTER_DATA_BRIDGE_EDMDELETE v1/data-bridge/de-register/{datasourcename}, DELETE v2/data-bridge/de-register/{datasourcename}
DLMDEPRECATED POST v1/accounts/{id}/process, POST v2/accounts/{id}/process, DEPRECATED POST v1/portfolios/{id}/process, POST v2/portfolios/{id}/process, POST v1/exposurebatches, POST v2/exposurebatches, POST v1/workflows
DOWNLOAD_EDMPOST v1/datasources
DOWNLOAD_LOCATION_RESULTSPOST v1/exports, POST v2/exports
DOWNLOAD_RDMPOST v1/exports, POST, v2/exports
EDM2EDMPOST v1/exports, POST v2/exports
EDM_UPGRADEPOST v1/datasources
EXPOSURE_BATCHESPOST v1/workflows
EXPOSURE_BATCH_EDITPOST v3/exposurebatches
EXTRACT_ELTPOST v1/analysis-groups, PUT v1/analysis-groups/{id}
GEOCODINGPOST v1/accounts/{id}/geohaz, POST v2/accounts/{id}/geohaz, POST v1/portfolios/{id}/geohaz, POST v2/portfolios/{id}/geohaz, POST v1/exposurebatches, POST v2/exposurebatches
GEOHAZPOST v1/workflows
GROUPINGPOST v1/analysis-groups, POST v1/analysis-groups/{id}/create-independent-group, PUT v1/analysis-groups/{id}, POST v2/analysis-groups, POST v2/analysis-groups/{id}/create-independent-group, PUT v2/analysis-groups/{id}, POST v1/workflows
GROUP_JOBTYPE_REGROUPPOST v1/analysis-groups/{id}/regroup, POST v2/analysis-groups/{id}/regroup
GROUPING_LOSS_POSTPROCESSORPOST v1/analysis-groups, PUT v1/analysis-groups
HAZARDPOST v1/accounts/{id}/geohaz, POST v2/accounts/{id}/geohaz, POST v1/portfolios/{id}/geohaz, POST v2/portfolios/{id}/geohaz, POST v1/exposurebatches, POST v2/exposurebatches
HDDEPRECATED POST v1/accounts/{id}/process, POST v2/accounts/{id}/process, DEPRECATED POST v1/portfolios/{id}/process, POST v2/portfolios/{id}/process, POST v1/exposurebatches, POST v2/exposurebatches
HD_ALMPOST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process, POST v2/exposurebatches
HD_ALM_GROUPINGPOST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process, POST v2/exposurebatches
HD_ENGINEDEPRECATED POST v1/accounts/{id}/process, POST v2/accounts/{id}/process, DEPRECATED POST v1/portfolios/{id}/process, POST v2/portfolios/{id}/process, POST v1/exposurebatches, POST v2/exposurebatches
HD_GROUPINGPUT v1/analysis-groups/{id}, POST v1/analysis-groups
HD_TO_RDMDEPRECATED POST v1/exports, POST v2/exports
MAP_PERSECTIVEPOST v1/analyses/{id}/map-perspective, POST v2/analyses/{id}/map-perspective
MARGINAL_IMPACTPOST /v1/analyses/{id}/marginal-impact, POST /v2/analyses/{id}/marginal-impact
MRI_IMPORTPOST v1/imports
PATEPOST v1/workflows, POST v1/analyses/{id}/pate, POST v2/analyses/{id}/pate
PROCESS_RDMPOST v1/uploads/{uploadId}/rdm
REGISTER_DATA_BRIDGE_EDMPOST v2/data-bridge/register
RENAME_ANALYSISPUT /v1/analyses/{id}/rename-analysis, PUT /v2/analyses/{id}/rename-analysis
REPORT_GENERATIONPOST v1/accounts/{id}/summary_report, POST v2/accounts/{id}/summary_report, POST v2/analysis/{id}/summary_report, POST v1/portfolios/{id}/summary_report
RERUNPOST /v1/analyses/{id}/rerun-ep, POST /v2/analyes/{id}/rerun-ep
SIMULATE_LOSSESPOST /V1/analyses/{id}/simulate-losses, POST /v2/analyses/{id}/simulate-losses
SIMULATIONPOST /V1/analyses/{id}/simulate-losses, POST /v2/analyses/{id}/simulate-losses
UDW_POSTPROCESSORPOST v1/accounts/{id}/geohaz
UPDATE_RESULTS_COUNTDELETE v1/analyses, DELETE v1/analyses/{id}, DELETE v2/analyses, DELETE v2/analyses/{id}
UPLOAD_EDMPOST v1/uploads/{uploadId}/edm
UPLOAD_RDMPOST v1/uploads/{uploadId}/rdm