API Reference

Search analysis results

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

Returns a list of analysis results.

An analysis result is an estimate of financial risk posed by an exposure.

Access rights to an analysis result is defined by a securable, the exposure set that secures the exposure that was the basis of the analysis.

Query Params
string

Query string to select response data based on property values.

PropertyData TypeComparisonList
analysisFrameworkString=, !=, LIKE, NOT LIKEIN, NOT IN
analysisIdNumber=, !=, >, <, >=, <=IN, NOT IN
analysisNameString=, !=, LIKE, NOT LIKEIN, NOT IN
analysisTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
appAnalysisIdNumber=, !=, >, <, >=, <=IN, NOT IN
createDateYYYY-MM-DD=, !=, >, <, >=, <=
currencyCodeString=, !=, LIKE, NOT LIKEIN, NOT IN
currencyNameString=, !=, LIKE, NOT LIKEIN, NOT IN
descriptionString=, !=, LIKE, NOT LIKEIN, NOT IN
engineIdNumber=, !=, >, <, >=, <=IN, NOT IN
engineTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
engineSubTypeIdNumber=, !=, >, <, >=, <=IN, NOT IN
engineSubTypeCodeString=, !=, LIKE, NOT LIKEIN, NOT IN
engineVersionString=, !=, LIKE, NOT LIKEIN, NOT IN
exposureNameString=, !=, LIKE, NOT LIKEIN, NOT IN
exposureResourceTypeIdNumber=, !=, >, <, >=, <=IN, NOT IN
exposureSetGuidString=, !=IN, NOT IN
insuranceTypeIdNumber=, !=, >, <, >=, <=IN, NOT IN
lossAmplificationIdNumber=, !=, >, <, >=, <=IN, NOT IN
modeIdNumber=, !=, >, <, >=, <=IN, NOT IN
perilString=, !=, LIKE, NOT LIKEIN, NOT IN
perilCodeString=, !=, LIKE, NOT LIKEIN, NOT IN
regionString=, !=, LIKE, NOT LIKEIN, NOT IN
regionCodeString=, !=, LIKE, NOT LIKEIN, NOT IN
securableTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
secuarableIdNumber=, !=, >, <, >=, <=IN, NOT IN
sourceRdmNameString=, !=, LIKE, NOT LIKEIN, NOT IN
securableIdNumber=, !=, >, <, >=, <=IN, NOT IN
securableTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
statusIdNumber=, !=, >, <, >=, <=IN, NOT IN
subperilString=, !=, LIKE, NOT LIKEIN, NOT IN
subPerilIdNumber=, !=, >, <, >=, <=IN, NOT IN
typeIdNumber=, !=, >, <, >=, <=IN, NOT IN
tagIdsNumber=, !=, >, <, >=, <=IN, NOT IN
usernameString=, !=, LIKE, NOT LIKEIN, NOT IN
vulnerabilityCurveIdNumber=, !=, >, <, >=, <=IN, NOT IN

Use the AND, OR logical operators to form compound queries. See Filtering Responses.

string

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

Supported properties: analysisFramework, analysisId, analysisName, analysisType, createDate, currencyCode, currencyName, description, engineType, engineVersion, exposureName, exposureResourceTypeId, exposureSetGuid, peril, region, securableId, securableType, sourceRdmName, subperil, username.

See Response Pagination.

int32
≤ 1000
Defaults to 100

Number of records returned per page; maximum is 1000. See Response Pagination

int32
Defaults to 0

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

Responses

Updated almost 2 years ago

Language
Credentials
URL
Response 
 Choose an example:
application/json
Updated almost 2 years ago