Creates, updates, or deletes exposures in batch. Multiple portfolio, account, location, and policy exposures may be managed in a single request.
This operation two methods for defining the exposure data that is imported.
- Request body method: Exposures are defined in the body of the request.
- File upload method: Exposures defined in a file that is uploaded to an Amazon S3 storage bucket, and then imported from that file
Request body method
In this method, the request body defines an object that consists of five arrays: a portfolios
array, accounts
array, locations
array, policies
, and treaties
array. Where parent-child relationships exist between exposures (e.g. between a portfolio and associated accounts), child exposures may be defined within the definition of the parent exposure.
{
"portfolios": [
{
"operationType": "UPDATE",
"label": "Port_LocationBatch_01_Label",
"accounts": [
{
"operationType": "UPDATE",
"label": "Acct_LocationBatch_01_Label",
"id": 23,
"policies": [...],
"locations": [...],
},
{...}
],
"id": 24,
"name": "Port_5_Name_Update",
"number": "Port_5_Num_Update",
"description": "Test_Location_Batch_Update",
"createDate": "2022-06-21T23:47:58.076Z",
"stampDate": null
}
]
}
Each array defines one or more operations that creates, edits, or deletes an exposure. An operation is defined by an optional operationType
, a required label
, and a required request body. The operationType
specifies the action performed (INSERT
, UPDATE
, or DELETE
). By default, INSERT
. The label
uniquely identifies an operation enabling you refer to that operation or the output of that operation in user-defined workflows. For details, see Process user-defined workflow. The request body specifies exposure attribute values:
- The
porfolios
array defines operations for creating, updating, or deleting portfolios. The array defines one or more portfolios and associated accounts. Required parameters depend on the operation type. For details, see Create portfolio, Update portfolio, or Delete portfolio. - The
accounts
array defines operations for creating, updating, or deleting accounts. The array defines one or more accounts and the associated locations and policies. Required parameters depend on the operation type. For details, see Create account, Update account, or Delete account. - The
locations
array defines operations for creating, updating, or deleting locations The array defines location attributes. Required parameters depend on the operation type. For details, see Create location, Update location, or Delete location. - The
policies
defines an array of operations for creating, updating, or deleting policies The array defines one or more policies. Required parameters depend on the operation type. For details, see Create policy, Update policy, or Delete policy. - The
treaties
defines an array of operations for creating, updating, or deleting treaties. The array defines one or more treaties. Required parameters depend on the operation type. For details, see Create treaty, Update treaty, or Delete treaty.
Note
This operation supports the processing of large number of exposures in a single request. Consequently, the size of the request package may be quite large. Maximum supported payload: 5MB. Request packages that define up to 1000 exposures may be submitted in JSON format:
Content-Type: application/json
File upload method
This operation enables workflows that import exposure data into EDMs from a JSON file uploaded to an storage bucket on AWS.
In this method, the request body specifies the uploadId
of a file that defines the exposures to import rather than defining exposures in request body.
{
"uploadId": "3ffc7d59-5c33-46ac-9511-5f4354979b69"
}
This method is similar to other Risk Modeler data migration workflows that leverage Amazon S3 storage buckets to facilitate the migration of large volumes of exposure data, e.g. the MRI workflow.
The workflow consists of three steps:
- Define exposure data in JSON file. Exposure data is structured as a request package for this operation.
- Use Get Storage Bucket URL to initialize a storage bucket on S3 for data upload. The response returns S3 credentials and the
uploadId
. The request must specifyEXPOSURE_BATCH_EDIT
as thedbType
andJSON
as thefileextension
. - Upload the JSON file to the storage bucket using Amazon S3 API operations.
- Specify the
uploadId
for the JSON file in the body of a Manage Exposures in Batch operation.
Note
UnderwriteIQ dedicated interactive queue is not supported if exosures are imported using this method.