API Reference

Create accumulation jobs as bulk batches

post
https://{host}/platform/accumulation/v1/bulk-batches
Headers
uuid
required

ID of resource group. Operation is assigned to this resource group's quota. See Resource Groups

Body Params
settings
array of objects
required
length ≥ 1
settings*
currency
object
required

Currency scheme with the version of exchange rates used in the accumulation analysis

eventInfo
object
required
financialPerspectives
array of strings
required

List of financial perspectives. See Financial Perspectives.

financialPerspectives*
string | null

Name of accumulation results.

  • If defined, every analysis result uses this name specified regardless of the number of accumulation profiles specified in the request.
  • If undefined, each accumulation result is automatically named for the accumulation profile used in that analysis.
string
profileIds
array of strings
required

List of accumulation profiles.

Each accumulation profile specifies general analysis settings (peril, geocoding version, etc.), scope (regions, layers, or targets), damages (damage factors and filters), and optional workers compensation settings.

profileIds*
tagIds
array of int32s

List of tags to apply to this job. See Tags.

tagIds
boolean
Defaults to false
resources
array of objects
required
length ≥ 1
resources*
string
enum
required

Type of exposure resource of accumulation analysis. One of portfolio, portfolioVariation

Allowed:
uri
required

URI of exposure resource, e.g. /platform/riskdata/v1/exposures/123/{exposureType}/12. See Resource URIs

portfolioProperties
object
Responses

Updated about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago