API Reference

Retrieve aggregate exposures

post
https://{host}/platform/import/v1/folders//files//retrieve-aggregate-exposures

Parses the aggregate exposure flat file staged in the specified ALM import folder and returns the data as a "grid" of aggregate exposure values.

The Retrieve Aggregate Exposures operation reads the staged flat file, aggregates the exposure data, and returns values, resolutionValues, and lobs as an aggregate exposure grid. The aggregate exposure grid is a transitory data structure. This grid must be saved as a data artifact using Update Aggregate Exposures operation before it is imported into the Intelligent Risk Platform.

The request specifies the insurance type of the data (PROPERTY or WORKERS_COMP), parser hints (delimiter, dataRowStart), the geography of the data (countryCode, resolution), and a columnMapping that maps destination properties to the columns of the file.

Path Params
string
required

ID of import file

string
required

ID of import folder

Body Params
string
enum
required

Insurance type of exposure data in uploaded flat file.

Allowed:
string
enum
required

Text delimiter used to separate columns of data in the uploaded flat file.

Allowed:
int32
required
≥ 1

Row number of the first row of aggregate exposure data. Use to ignore header rows.

string
required

Two-letter ISO 3166 code of the country uploaded exposure data. WORKERS_COMP data supports US only.

string
required

Geographic granularity used to aggregate the uploaded exposure data, For example, State, County, or Postal Code. Child of the specified dependencyResolution. For example, County is the child of State.

The geographic granularity at which exposure data is aggregated. Identifies the geographic unit (e.g. State, County, Postal Code, CRESTA) into which the file's rows are summed, and those units become the resolutionValues rows of the returned grid.

string | null

Parent resolution of the specified resolution value. For example, State is the parent of County. Required for nested resolutions. Top-level resolutions (e.g. State, CRESTA, or Province) have not parent.

string

Resolution of the source data.

To aggregate the data into a coarser resolution, specify the file's resolution in resolutionConversionFrom and the target resolution in resolutionConversionTo.

string

Resolution of aggregate exposure grid.

columnMapping
object
required

Map of destination fields to source column numbers in the file.

For property data, map the geography fields plus one field per line of business. For workers' compensation data, map State, Occ Scheme, Occ Type, and Payroll, plus County or Postal Code when required by the resolution.

Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 days ago

Did this page help you?