API Reference

Search EDMs

get
https://{host}/platform/riskdata/v1/exposures

Returns a list of EDMs (exposure data modules).

An exposure (EDM) is a database structure that stores detailed exposure, hazard, and financial information for use in catastrophe modeling. Exposure data stored in an EDM may be used for risk analysis or for migration to other Intelligent Risk Platform products. A tenant may own multiple EDMs on multiple servers.

Headers
boolean
Defaults to false

If true, response returns x-total-count header with the number of exposures (EDMs).

Query Params
string

Query string to select response data based on property values.

Supported properties: exposureId, exposureName, ownerName, serverName, status, tagIds. Operators depend on the data type of the property.

PropertyData TypeComparisonList
exposureIdNumber=, !=, >, <, >=, <=IN NOT IN
exposureNameString=, !=, LIKE, NOT LIKEIN NOT IN
exposureSetIdNumber=, !=, >, <, >=, <=IN NOT IN
ownerNameString=, !=, LIKE, NOT LIKEIN NOT IN
serverNameString=, !=, LIKE, NOT LIKEIN NOT IN
statusString=, !=, LIKE, NOT LIKEIN NOT IN
tagIdsArray=, !=IN NOT IN
createdByString=IN
updatedByString=IN
createdAtYYYY-MM-DD= > <
updatedAtYYYY-MM-DD= > <

Use the AND and OR logical operators to defined compound queries. See Filtering Responses.

string
Defaults to exposureName ASC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: createdBy, createdAt, exposureId, exposureName, ownerName, serverName, status, updatedBy, updatedAt. See Response Pagination.

int32
≥ 1
Defaults to 100

Number of records returned per page. See Response Pagination

int32
≥ 0
Defaults to 0

Number of the page displaying the returned records, starting at 0

Responses

Updated 9 days ago

Language
Credentials
URL
Response 
 Choose an example:
application/json
Updated 9 days ago