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.

Status	Description
`QUEUED`	Indicates that the workflow engine has created the job and added it to the queue for processing.
`PENDING`	Indicates that the workflow engine is about to be processed.
`RUNNING`	Indicates that the workflow engine is processing the job.
`FINISHED`	Indicates that the workflow engine has finished processing the job.
`FAILED`	Indicates that the job has failed.
`CANCEL_REQUESTED`	Indicates that the client has requested that the workflow engine cancel job using the Cancel Job resource.
`CANCELLING`	Indicates that the workflow engine is cancelling the job.
`CANCELLED`	Indicates 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.

Job	Resources
`ALM`	POST v2/exposurebatches, POST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process
`ALM_IMPORT`	[POST v1/imports]
`BULK_EDIT`	POST v1/globaledit
`CLIMATE_CHANGE`	POST /v1/analyses/{id}/climate-change, POST /v2/analyses/{id}/climate-change
`CONFIGURE_DLM`	DEPRECATED 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_CURRENCY`	POST v1/accounts/{id}/convertcurrency, POST v2/accounts/{id}/convertcurrency
`CONVERT_AGGREGATE_PORTFOLIO_CURRENCY`	POST v1/aggregate-portfolios/{id})/convertcurrency, POST v2/accounts/{id}/convertcurrency, POST v2/aggregate-portfolios/{id}/convertcurrency, POST v2/accounts/{id}/convertcurrency
`CONVERT_EVENT_RATE_LOSS`	POST v1/analyses/{id}/convert-event-rate-loss, POST v2/analyses/{id}/convert-event-rate-loss
`CONVERT_PORTFOLIO_CURRENCY`	POST v1/portfolios/{id}/convertcurrency,POST v2/portfolios/{id}/convertcurrency
`CONVERT_RESULT_CURRENCY`	POST v1/analyses/{id}/convertcurrency, POST v2/analyses/{id}/convertcurrency
`CONVERT_TREATY_CURRENCY`	POST v1/treaties/{id}/convertcurrency
`COPY_ACCOUNT`	POST v1/accounts/{id}/copy, POST v2/accounts/{id}/copy
`COPY_AGGPORT`	POST v1/aggregate-porfolios/{id}/copy, POST v2/aggregate-porfolios/{id}/copy
`COPY_PORTFOLIO`	POST v1/portfolios/{id}/copy, POST v2/portfolios/{id}/copy
`CREATE_EDM`	POST v1/datasources
`DELETE_ACCOUNT`	DELETE v1/accounts/{id}, DELETE v2/accounts/{id}
`DELETE_AGGREGATE_PORTFOLIO`	DELETE v1/aggregate-porfolios/{id}, DELETE v2/aggregate-portfolios/{id}
`DELETE_EDM`	DELETE v1/datasources/{datasourcename}
`DELETE_PORTFOLIO`	DELETE v1/portfolios/{id}, DELETE v2/portfolios/{id}
`DELETE_RDM`	POST v1/exports, POST v2/exports
`DEREGISTER_DATA_BRIDGE_EDM`	DELETE v1/data-bridge/de-register/{datasourcename}, DELETE v2/data-bridge/de-register/{datasourcename}
`DLM`	DEPRECATED 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_EDM`	POST v1/datasources
`DOWNLOAD_LOCATION_RESULTS`	POST v1/exports, POST v2/exports
`DOWNLOAD_RDM`	POST v1/exports, POST, v2/exports
`EDM2EDM`	POST v1/exports, POST v2/exports
`EDM_UPGRADE`	POST v1/datasources
`EXPOSURE_BATCHES`	POST v1/workflows
`EXPOSURE_BATCH_EDIT`	POST v3/exposurebatches
`EXTRACT_ELT`	POST v1/analysis-groups, PUT v1/analysis-groups/{id}
`GEOCODING`	POST 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
`GEOHAZ`	POST v1/workflows
`GROUPING`	POST 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_REGROUP`	POST v1/analysis-groups/{id}/regroup, POST v2/analysis-groups/{id}/regroup
`GROUPING_LOSS_POSTPROCESSOR`	POST v1/analysis-groups, PUT v1/analysis-groups
`HAZARD`	POST 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
`HD`	DEPRECATED 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_ALM`	POST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process, POST v2/exposurebatches
`HD_ALM_GROUPING`	POST v1/aggregate-portfolios/{id}/process, POST v2/aggregate-portfolios/{id}/process, POST v2/exposurebatches
`HD_ENGINE`	DEPRECATED 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_GROUPING`	PUT v1/analysis-groups/{id}, POST v1/analysis-groups
`HD_TO_RDM`	DEPRECATED POST v1/exports, POST v2/exports
`MAP_PERSECTIVE`	POST v1/analyses/{id}/map-perspective, POST v2/analyses/{id}/map-perspective
`MARGINAL_IMPACT`	POST /v1/analyses/{id}/marginal-impact, POST /v2/analyses/{id}/marginal-impact
`MRI_IMPORT`	POST v1/imports
`PATE`	POST v1/workflows, POST v1/analyses/{id}/pate, POST v2/analyses/{id}/pate
`PROCESS_RDM`	POST v1/uploads/{uploadId}/rdm
`REGISTER_DATA_BRIDGE_EDM`	POST v2/data-bridge/register
`RENAME_ANALYSIS`	PUT /v1/analyses/{id}/rename-analysis, PUT /v2/analyses/{id}/rename-analysis
`REPORT_GENERATION`	POST v1/accounts/{id}/summary_report, POST v2/accounts/{id}/summary_report, POST v2/analysis/{id}/summary_report, POST v1/portfolios/{id}/summary_report
`RERUN`	POST /v1/analyses/{id}/rerun-ep, POST /v2/analyes/{id}/rerun-ep
`SIMULATE_LOSSES`	POST /V1/analyses/{id}/simulate-losses, POST /v2/analyses/{id}/simulate-losses
`SIMULATION`	POST /V1/analyses/{id}/simulate-losses, POST /v2/analyses/{id}/simulate-losses
`UDW_POSTPROCESSOR`	POST v1/accounts/{id}/geohaz
`UPDATE_RESULTS_COUNT`	DELETE v1/analyses, DELETE v1/analyses/{id}, DELETE v2/analyses, DELETE v2/analyses/{id}
`UPLOAD_EDM`	POST v1/uploads/{uploadId}/edm
`UPLOAD_RDM`	POST v1/uploads/{uploadId}/rdm