Resources to manage batch jobs
Overview
The Batch API exposes operations that enable client applications to define and execute user-defined workflows as batch jobs.
A user-defined workflow is a series of operations that are managed in sequence. These operations are defined as a series of task objects in JSON format. Each of these tasks represents an expensive or long-running process that is submitted to the workflow engine in a single request as part of a BATCH job for processing.
Operations
| Operation | Method | Endpoint | Description |
|---|---|---|---|
| Create Batch Job | POST | /platform/batch/v1/jobs | Creates a batch job. |
| Search Batch Jobs | GET | /platform/batch/v1/jobs | Returns list of batch jobs. |
| Get Batch Job | GET | /platform/batch/v1/jobs/{jobId} | Returns batch job. |
| Update Batch Job | PATCH | /platform/batch/v1/jobs/{jobId} | Updates batch job. |
| Get Batch Job Task | GET | /platform/batch/v1/jobs/{jobId}/tasks/{taskId} | Returns task. |
Entitlements
Client must be assigned one of the following entitlements to use this API:
RI-RISKMODELERRI-UNDERWRITEIQ
User-Defined Workflows
A user-defined workflow is a workflow that consists of a series of tasks that are processed in the specified order.
For example, a batch job can define a workflow that consists of multiple tasks that perform the following operations in sequence: 1) create new account exposures, 2) generate an exposure summary report for those accounts, 3) geocode and hazard those accounts, 4) export location exposure data for those accounts.
For each task in the workflow, the batch job initiates a separate job to process that request. Each job in the workflow must be completed before the next task in the workflow can be started. The batch job manages the polling of jobs and the passing of operation outputs (e.g. new object IDs) between tasks using task path variables.
Batch Templates
A batch template is a collection of analysis settings that are used to generate report views in UnderwriteIQ.
Batch templates may specify model profile settings, event rate sets, output profile versions, analysis settings including DLM configurations and analysis currency, and report settings. Batch templates can be used as analysis templates in the UnderwriteIQ application. To learn more, see Workflow Builder in Help Center.
Postman Collections
The RMS Developers Postman site houses a number of Postman collections that provide working samples of UnderwriteIQ workflows.