{ "opencollection": "1.0.0", "info": { "name": "Risk Modeler", "version": "March, 2023" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "AccountV1", "type": "folder" }, "items": [ { "info": { "name": "Get accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages that are offset before the initial page of records returned. By default, _0_" }, { "name": "portfoliofilter", "value": "", "type": "query", "description": "Indicates if search was triggered by portfolio." }, { "name": "policyExpirationDays", "value": "", "type": "query", "description": "The date the latest policy expires." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get accounts" }, { "info": { "name": "Create account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create account" }, { "info": { "name": "Count accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count accounts" }, { "info": { "name": "Get account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update account" }, { "info": { "name": "Delete account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete account" }, { "info": { "name": "Get results by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages that are offset before the initial page of records returned. By default, _0_." }, { "name": "userName", "value": "", "type": "query", "description": "Name of <> that ran the analysis." }, { "name": "runDate", "value": "", "type": "query", "description": "Date that the analysis was run." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results by account" }, { "info": { "name": "Copy account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy account" }, { "info": { "name": "Geohazard account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/geohaz", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geohazard account" }, { "info": { "name": "Convert currency by account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by account" }, { "info": { "name": "Get account locations", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/coordinate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "latitude", "value": "", "type": "query", "description": "Latitude coordinates." }, { "name": "longitude", "value": "", "type": "query", "description": "Longitude coordinates." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account locations" }, { "info": { "name": "Get location coordinates by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/coordinates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location coordinates by account" }, { "info": { "name": "Get countries by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/countries", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries by account" }, { "info": { "name": "Count locations by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/locationcount", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count locations by account" }, { "info": { "name": "Get metrics by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by account" }, { "info": { "name": "Move account to EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/move", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "option", "value": "", "type": "query", "description": "Include (`1`) or exclude (`0`) locations in moved account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Move account to EDM" }, { "info": { "name": "Count policies by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/policycount", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count policies by account" }, { "info": { "name": "Analyze account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze account" }, { "info": { "name": "Get account reports", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/reports", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display on the page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": " " }, { "info": { "name": "Get sites by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/sites", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get sites by account" }, { "info": { "name": "Generate summary report by account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/accounts/:id/summary_report", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generate summary report by account" }, { "info": { "name": "Get surplus treaties by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/surplustreatieslocation", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get surplus treaties by account" }, { "info": { "name": "Validate account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/validate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate account" }, { "info": { "name": "Get validation files by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/accounts/:id/validatemedia", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get validation files by account" } ] }, { "info": { "name": "AccountV2", "type": "folder" }, "items": [ { "info": { "name": "Get accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display on the page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" }, { "name": "portfoliofilter", "value": "", "type": "query", "description": "If This search was triggered from portfolio starting at _0_." }, { "name": "policyExpirationDays", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get accounts" }, { "info": { "name": "Create account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create account" }, { "info": { "name": "Count accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count accounts" }, { "info": { "name": "Get account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update account" }, { "info": { "name": "Delete account", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete account" }, { "info": { "name": "Get results by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" }, { "name": "userName", "value": "", "type": "query", "description": "Name of <> that ran the analysis." }, { "name": "runDate", "value": "", "type": "query", "description": "Date that the analysis was run." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results by account" }, { "info": { "name": "Convert currency by account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by account" }, { "info": { "name": "Copy account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy account" }, { "info": { "name": "Get account locations", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/coordinate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "latitude", "value": "", "type": "query", "description": "Latitude coordinates." }, { "name": "longitude", "value": "", "type": "query", "description": "Longitude coordinates." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account locations" }, { "info": { "name": "Get location coordinates by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/coordinates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location coordinates by account" }, { "info": { "name": "Get countries by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/countries", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries by account" }, { "info": { "name": "Count locations by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/locationcount", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count locations by account" }, { "info": { "name": "Geohazard account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/geohaz", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geohazard account" }, { "info": { "name": "Get metrics by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by account" }, { "info": { "name": "Move account to EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/move", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "option", "value": "", "type": "query", "description": "Include (`1`) or exclude (`0`) locations in moved account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Move account to EDM" }, { "info": { "name": "Count policies by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/policycount", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count policies by account" }, { "info": { "name": "Analyze account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze account" }, { "info": { "name": "Get sites by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/sites", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get sites by account" }, { "info": { "name": "Get account reports", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/reports", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get account reports" }, { "info": { "name": "Generate summary report by account", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/accounts/:id/summary_report", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generate summary report by account" }, { "info": { "name": "Get surplus treaties by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/surplustreatieslocation", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get surplus treaties by account" }, { "info": { "name": "Validate account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/validate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate account" }, { "info": { "name": "Get validation file by account", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/accounts/:id/validatemedia", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the account." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get validation file by account" } ] }, { "info": { "name": "Aggregate PortfolioV1", "type": "folder" }, "items": [ { "info": { "name": "Get aggregate portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate portfolios" }, { "info": { "name": "Create aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create aggregate portfolio" }, { "info": { "name": "Count aggregate portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count aggregate portfolios" }, { "info": { "name": "Get aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate portfolio" }, { "info": { "name": "Update aggregate portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update aggregate portfolio" }, { "info": { "name": "Delete aggregate portfolio", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete aggregate portfolio" }, { "info": { "name": "Get exposures by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/aggregate-exposures-lists", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "countryCode", "value": "", "type": "query", "description": "Country to filter by." }, { "name": "resolution", "value": "", "type": "query", "description": "Resolution to filter by." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get exposures by aggregate portfolio" }, { "info": { "name": "Get results by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results by aggregate portfolio" }, { "info": { "name": "Convert currency by aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/convert-currency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by aggregate portfolio" }, { "info": { "name": "Copy aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy aggregate portfolio" }, { "info": { "name": "Get countries by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/countries", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries by aggregate portfolio" }, { "info": { "name": "Get metrics by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by aggregate portfolio" }, { "info": { "name": "Analyze aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze aggregate portfolio" }, { "info": { "name": "Get ALM profiles by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/profiles", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "softwareVersionCode", "value": "", "type": "query", "description": "Software version code." }, { "name": "includeHD", "value": "", "type": "query", "description": "Indicator to include HD profiles" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get ALM profiles by aggregate portfolio" }, { "info": { "name": "Get treaties by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/aggregate-portfolios/:id/treaties", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties by aggregate portfolio" } ] }, { "info": { "name": "Aggregate PortfolioV2", "type": "folder" }, "items": [ { "info": { "name": "Get aggregate portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate portfolios" }, { "info": { "name": "Create aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create aggregate portfolio" }, { "info": { "name": "Count aggregate portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count aggregate portfolios" }, { "info": { "name": "Get aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate portfolio" }, { "info": { "name": "Update aggregate portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update aggregate portfolio" }, { "info": { "name": "Delete aggregate portfolio", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete aggregate portfolio" }, { "info": { "name": "Get results by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "userName", "value": "", "type": "query", "description": "Name of <> that submitted the workflow." }, { "name": "runDate", "value": "", "type": "query", "description": "Date that the analysis was run." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results by aggregate portfolio" }, { "info": { "name": "Get aggregate exposures by aggregate", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/aggregate-exposures-lists", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "countryCode", "value": "", "type": "query", "description": "Country to filter by." }, { "name": "resolution", "value": "", "type": "query", "description": "Resolution to filter by." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate exposures by aggregate" }, { "info": { "name": "Convert currency by aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/convert-currency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by aggregate portfolio" }, { "info": { "name": "Copy aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy aggregate portfolio" }, { "info": { "name": "Get countries by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/countries", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get countries by aggregate portfolio" }, { "info": { "name": "Get metrics by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by aggregate portfolio" }, { "info": { "name": "Analyze aggregate portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze aggregate portfolio" }, { "info": { "name": "Get ALM profiles by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/profiles", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "softwareVersionCode", "value": "", "type": "query", "description": "Software version code." }, { "name": "includeHD", "value": "", "type": "query", "description": "Indicator to include HD profiles" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get ALM profiles by aggregate portfolio" }, { "info": { "name": "Get treaties by aggregate portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/aggregate-portfolios/:id/treaties", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the aggregate portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties by aggregate portfolio" } ] }, { "info": { "name": "Analysis GroupsV1", "type": "folder" }, "items": [ { "info": { "name": "Get analysis groups", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analysis-groups", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get analysis groups" }, { "info": { "name": "Create analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analysis-groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create analysis group" }, { "info": { "name": "Get analysis group", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analysis-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Analysis Group ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get analysis group" }, { "info": { "name": "Update analysis group", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/analysis-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the Analysis Group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update analysis group" }, { "info": { "name": "Regroup analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analysis-groups/:id/regroup", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the Analysis Group." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Regroup analysis group" }, { "info": { "name": "Validate analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analysis-groups/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate analysis group" } ] }, { "info": { "name": "Analysis GroupsV2", "type": "folder" }, "items": [ { "info": { "name": "Get analysis groups", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analysis-groups", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get analysis groups" }, { "info": { "name": "Create analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analysis-groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create analysis group" }, { "info": { "name": "Get analysis group", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analysis-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Analysis Group ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get analysis group" }, { "info": { "name": "Update analysis group", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/analysis-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the Analysis Group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update analysis group" }, { "info": { "name": "Regroup analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analysis-groups/:id/regroup", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the Analysis Group." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Regroup analysis group" }, { "info": { "name": "Validate analysis group", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analysis-groups/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Validate analysis group" } ] }, { "info": { "name": "BranchV1", "type": "folder" }, "items": [ { "info": { "name": "Get branches", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/branches", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get branches" }, { "info": { "name": "Create branch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/branches", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create branch" }, { "info": { "name": "Get branch by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/branches/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the branch." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get branch by ID" }, { "info": { "name": "Update branch", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/branches/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the branch." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update branch" }, { "info": { "name": "Delete branch", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/branches/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the branch." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete branch" } ] }, { "info": { "name": "CedantV1", "type": "folder" }, "items": [ { "info": { "name": "Get cedants", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/cedants", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get cedants" }, { "info": { "name": "Create cedant", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/cedants", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create cedant" }, { "info": { "name": "Get cedant", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/cedants/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the cedant." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get cedant" }, { "info": { "name": "Update cedant", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/cedants/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the cedant." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update cedant" }, { "info": { "name": "Delete cedant", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/cedants/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the cedant." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete cedant" } ] }, { "info": { "name": "DatasourcesV1", "type": "folder" }, "items": [ { "info": { "name": "Get EDMs", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/datasources", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records starting at `0`.'" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EDMs" }, { "info": { "name": "Administer EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/datasources", "params": [ { "name": "datasourcename", "value": "", "type": "query", "description": "Unique name of EDM data source. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and ' ' (space). Maximum length is 80 characters." }, { "name": "filename", "value": "", "type": "query", "description": "Name of the file for download. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and '' '' (space)." }, { "name": "operation", "value": "", "type": "query", "description": "Database operation to perform. One of `CREATE`, `DOWNLOAD_EDM`, or `EDM_DATA_UPGRADE`." }, { "name": "servername", "value": "", "type": "query", "description": "Name of server instance hosting the EDM." }, { "name": "format", "value": "", "type": "query", "description": "File format downloaded database artifact. By default, `BAK`." }, { "name": "sqlversion", "value": "", "type": "query", "description": "SQL server version of exported BAK or MDF." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Administer EDM" }, { "info": { "name": "Delete EDM", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/datasources/:datasourcename", "params": [ { "name": "datasourcename", "value": "", "type": "path", "description": "Data source name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete EDM" }, { "info": { "name": "Get SQL Server instances", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/datasources/db-instances", "params": [ { "name": "type", "value": "", "type": "query", "description": "DB instance namespace RM or Data Bridge" }, { "name": "status", "value": "", "type": "query", "description": "DB instance status active or inactive" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SQL Server instances" } ] }, { "info": { "name": "DatasourcesV2", "type": "folder" }, "items": [ { "info": { "name": "Get EDMs", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/datasources", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EDMs" }, { "info": { "name": "Administer EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/datasources", "params": [ { "name": "datasourcename", "value": "", "type": "query", "description": "Unique name of EDM data source. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and ' ' (space). Maximum length is 80 characters." }, { "name": "filename", "value": "", "type": "query", "description": "Name of the file for download. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and '' '' (space)." }, { "name": "operation", "value": "", "type": "query", "description": "Database operation to perform. One of `CREATE`, `DOWNLOAD_EDM`, or `EDM_DATA_UPGRADE`." }, { "name": "servername", "value": "", "type": "query", "description": "Name of server instance hosting the EDM." }, { "name": "format", "value": "", "type": "query", "description": "File format downloaded database artifact. By default, `BAK`." }, { "name": "sqlversion", "value": "", "type": "query", "description": "SQL server version of exported BAK or MDF." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Administer EDM" }, { "info": { "name": "Delete EDM", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/datasources/:datasourcename", "params": [ { "name": "datasourcename", "value": "", "type": "path", "description": "Data source name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete EDM" }, { "info": { "name": "Get SQL Server instances", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/datasources/db-instances", "params": [ { "name": "type", "value": "", "type": "query", "description": "DB instance namespace RM or Data Bridge" }, { "name": "status", "value": "", "type": "query", "description": "DB instance status active or inactive" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get SQL Server instances" } ] }, { "info": { "name": "DatastoreV1", "type": "folder" }, "items": [ { "info": { "name": "Get data modules on Data Bridge", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/data-bridge/:serverId/databases", "params": [ { "name": "serverId", "value": "", "type": "path" }, { "name": "dbType", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records starting at `0`.'" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get data modules on Data Bridge" }, { "info": { "name": "Register EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/data-bridge/register", "params": [ { "name": "datasourcename", "value": "", "type": "query", "description": "Name of the datasource to register with Risk Modeler." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Register EDM" }, { "info": { "name": "Deregister EDM", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/data-bridge/de-register/:datasourcename", "params": [ { "name": "datasourcename", "value": "", "type": "path", "description": "Data source name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deregister EDM" } ] }, { "info": { "name": "DatastoreV2", "type": "folder" }, "items": [ { "info": { "name": "Get data modules on Data Bridge", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/data-bridge/:serverId/databases", "params": [ { "name": "serverId", "value": "", "type": "path" }, { "name": "dbType", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get data modules on Data Bridge" }, { "info": { "name": "Register EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/data-bridge/register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Register EDM" }, { "info": { "name": "Deregister EDM", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/data-bridge/de-register/:datasourcename", "params": [ { "name": "datasourcename", "value": "", "type": "path", "description": "Data source name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deregister EDM" } ] }, { "info": { "name": "DomainsV1", "type": "folder" }, "items": [ { "info": { "name": "Get domains", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get domains" }, { "info": { "name": "Get tablespaces", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get tablespaces" }, { "info": { "name": "Get entities by domain tablespace", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get entities by domain tablespace" }, { "info": { "name": "Get entity by domain tablespace", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get entity by domain tablespace" }, { "info": { "name": "Create currency", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create currency" }, { "info": { "name": "Get hazards", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity/hazards", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." }, { "name": "jsonfield", "value": "", "type": "query", "description": "Name of the field user wants to fetch in the hazards." }, { "name": "option", "value": "", "type": "query", "description": "Optional attribute to filter the values. Defaults to returning all values." }, { "name": "tag", "value": "", "type": "query", "description": "Name of the metadata tag." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sortby", "value": "", "type": "query", "description": "The name of the field on which to sort the results." }, { "name": "sortorder", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get hazards" }, { "info": { "name": "Get attributes domain tablespace entity", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity/meta", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." }, { "name": "tag", "value": "", "type": "query", "description": "Name of the metadata tag." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get attributes domain tablespace entity" }, { "info": { "name": "Get secondary modifiers", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity/secondarymodifiers", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." }, { "name": "jsonfield", "value": "", "type": "query", "description": "Name of the field user wants to fetch in the secondary modifiers." }, { "name": "option", "value": "", "type": "query", "description": "Optional attribute to filter the values. Defaults to returning all values." }, { "name": "tag", "value": "", "type": "query", "description": "Name of the metadata tag." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sortby", "value": "", "type": "query", "description": "The name of the field on which to sort the results." }, { "name": "sortorder", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records \\ starting at _0_.'" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get secondary modifiers" }, { "info": { "name": "Get entity values", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/domains/:domainname/tablespace/:tablespace/entities/:entity/values", "params": [ { "name": "domainname", "value": "", "type": "path", "description": "Name of the domain." }, { "name": "tablespace", "value": "", "type": "path", "description": "Name of the tablespace." }, { "name": "entity", "value": "", "type": "path", "description": "Name of the entity." }, { "name": "fields", "value": "", "type": "query", "description": "Comma delimited list of fields to be fetched. Defaults to all." }, { "name": "tag", "value": "", "type": "query", "description": "Name of the metadata tag." }, { "name": "attributename", "value": "", "type": "query" }, { "name": "sortby", "value": "", "type": "query", "description": "This parameter is not currently used." }, { "name": "sortorder", "value": "", "type": "query", "description": "This parameter is not currently used." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Optional attribute to filter the values. Defaults to returning all values." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get entity values" } ] }, { "info": { "name": "ExportsV1", "type": "folder" }, "items": [ { "info": { "name": "Export data module to file", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/exports", "params": [ { "name": "servername", "value": "", "type": "query", "description": "The optional `servername` query parameter specifies the name of the server." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Export data module to file" }, { "info": { "name": "Download analysis results", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/exports/downloadresults", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Download analysis results" } ] }, { "info": { "name": "ExportsV2", "type": "folder" }, "items": [ { "info": { "name": "Export data module to file", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/exports", "params": [ { "name": "servername", "value": "", "type": "query", "description": "The optional `servername` query parameter specifies the name of the server." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Export data module to file" } ] }, { "info": { "name": "Exposure BatchV3", "type": "folder" }, "items": [ { "info": { "name": "Manage exposures in batch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v3/exposurebatches", "headers": [ { "name": "Content-Encoding", "value": "" } ], "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage exposures in batch" } ] }, { "info": { "name": "Exposure SetsV1", "type": "folder" }, "items": [ { "info": { "name": "Get exposure sets", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/exposuresets", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters applied to the query results of the `id` or `name` attribute. The operation supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order for query results based on the `id` or `name` attribute. Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records starting at ''0''.'" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get exposure sets" }, { "info": { "name": "Update exposure set", "type": "http" }, "http": { "method": "PATCH", "url": "https://{host}/riskmodeler/v1/exposuresets/:exposureSetId", "params": [ { "name": "exposureSetId", "value": "", "type": "path", "description": "ID of the exposure set to update." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update exposure set" }, { "info": { "name": "Get groups by exposure set", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/exposuresets/:exposureSetId/groups", "params": [ { "name": "exposureSetId", "value": "", "type": "path", "description": "ID exposure set to update." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get groups by exposure set" } ] }, { "info": { "name": "File StorageV1", "type": "folder" }, "items": [ { "info": { "name": "Create storage bucket", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/storage", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create storage bucket" }, { "info": { "name": "Extract aggregate exposure values", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/storage/:bucketId/files/:fileId/aggregate-exposures-lists", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "Bucket ID" }, { "name": "fileId", "value": "", "type": "path", "description": "ID of the file." }, { "name": "delimiter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Extract aggregate exposure values" }, { "info": { "name": "Get file URI by storage bucket", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/storage/:bucketId/files/:fileId/media", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "Bucket ID" }, { "name": "fileId", "value": "", "type": "path", "description": "ID of the file requested." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get file URI by storage bucket" }, { "info": { "name": "Get aggregate exposures", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/storage/:bucketId/files/aggregate-exposures-lists", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "Bucket ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get aggregate exposures" }, { "info": { "name": "Get file location on S3", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/storage/:bucketId/path", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "Bucket ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get file location on S3" }, { "info": { "name": "Get storage bucket URL", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/uploads", "params": [ { "name": "filename", "value": "", "type": "query", "description": "Name of the file. Includes the file extension." }, { "name": "dbtype", "value": "", "type": "query", "description": "Database type of the data source. One of `ANLSHAZARD`, `DLMPROFILES`, `EDM`, `EVENTINFO`, `GEOCODE`, `GEOGRAPHY`, `MAPCONFIG`, `NONE`, `RDM`, `REPORT`, `SYSTEMDATA`, `TABDATA`, `TARGET`, `USERCONFIG`, `UWG`, `VULNERABILITY`, `WEB`. " }, { "name": "fileextension", "value": "", "type": "query", "description": "File extension of file. One of `BAK`, `CSV`, `MDF`, or `PARQUET`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get storage bucket URL" }, { "info": { "name": "Upload EDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/uploads/:uploadId/edm", "params": [ { "name": "uploadId", "value": "", "type": "path", "description": "ID for upload requested." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM to be created. Data Source name can only contain characters from 0-9 A-Z a-z and _ (underscore) - (hyphen) and ' '(space)" }, { "name": "servername", "value": "", "type": "query", "description": "Name of the server instance to host the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload EDM" }, { "info": { "name": "Upload RDM", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/uploads/:uploadId/rdm", "params": [ { "name": "uploadId", "value": "", "type": "path", "description": "ID for AWS upload task or name of RDM on Data Bridge." }, { "name": "servername", "value": "", "type": "query", "description": "Name of the server instance hosting the RDM. Required if `importFromServer` is `true`." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Upload RDM" } ] }, { "info": { "name": "ImportsV1", "type": "folder" }, "items": [ { "info": { "name": "Import exposures from file", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/imports", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Import exposures from file" }, { "info": { "name": "Create account source file", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/imports/createaccount/:bucketId", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "ID number of the <>." }, { "name": "delimiter", "value": "", "type": "query", "description": "Text delimiter for account data. One of `TAB`, `COMMA`, `SEMICOLON`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create account source file" }, { "info": { "name": "Create import mapping file", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/imports/createmapping/:bucketId", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "ID number of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create import mapping file" }, { "info": { "name": "Extract account data from MRI location file", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/imports/extractaccountsfromlocationfile/:bucketId/:fileId", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "Bucket ID." }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" }, { "name": "delimiter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Extract account data from MRI location file" }, { "info": { "name": "Extract data from MRI mapping file", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/imports/extractmapping/:bucketId/:fileId", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "ID number of the <>." }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Extract data from MRI mapping file" }, { "info": { "name": "Extract data from MRI file", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/imports/extractsample/:bucketId/:fileId", "params": [ { "name": "bucketId", "value": "", "type": "path", "description": "ID number of the <>." }, { "name": "fileId", "value": "", "type": "path" }, { "name": "delimiter", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Extract data from MRI file" } ] }, { "info": { "name": "Line of BusinessV1", "type": "folder" }, "items": [ { "info": { "name": "Get lines of business", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/lobs", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get lines of business" }, { "info": { "name": "Create line of business", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/lobs", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create line of business" }, { "info": { "name": "Get line of business by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/lobs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the LineOfBusiness." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get line of business by ID" }, { "info": { "name": "Update line of business", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/lobs/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update line of business" }, { "info": { "name": "Delete line of business", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/lobs/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete line of business" } ] }, { "info": { "name": "LocationV1", "type": "folder" }, "items": [ { "info": { "name": "Get locations", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" }, { "name": "withflzone", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get locations" }, { "info": { "name": "Create location", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create location" }, { "info": { "name": "Get location", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location" }, { "info": { "name": "Update location", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update location" }, { "info": { "name": "Delete location", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete location" }, { "info": { "name": "Create BI peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationbidetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create BI peril" }, { "info": { "name": "Get BI peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationbidetail/:locationbidetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationbidetailid", "value": "", "type": "path", "description": "ID number of the location bi detail record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get BI peril" }, { "info": { "name": "Update BI peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationbidetail/:locationbidetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationbidetailid", "value": "", "type": "path", "description": "ID number of the location bi detail record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update BI peril" }, { "info": { "name": "Delete BI peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationbidetail/:locationbidetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationbidetailid", "value": "", "type": "path", "description": "ID number of the location bi detail record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete BI peril" }, { "info": { "name": "Add location condition", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationcondition", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Add location condition" }, { "info": { "name": "Manage location conditions in batch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/locationcondition/batch", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage location conditions in batch" }, { "info": { "name": "Get location condition", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationcondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the location condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location condition" }, { "info": { "name": "Update location condition", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationcondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the location condition record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update location condition" }, { "info": { "name": "Delete location condition", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationcondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the location condition record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete location condition" }, { "info": { "name": "Create location coverage", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/coverage", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create location coverage" }, { "info": { "name": "Get location coverage", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the location coverage record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location coverage" }, { "info": { "name": "Update coverage", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the location coverage record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update coverage" }, { "info": { "name": "Delete location coverage", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the location coverage record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete location coverage" }, { "info": { "name": "Create EQ peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationeqdetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create EQ peril" }, { "info": { "name": "Get EQ peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationeqdetail/:locationeqdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationeqdetailid", "value": "", "type": "path", "description": "ID number of the location earthquake record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EQ peril" }, { "info": { "name": "Update EQ peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationeqdetail/:locationeqdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationeqdetailid", "value": "", "type": "path", "description": "ID number of the location earthquake record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update EQ peril" }, { "info": { "name": "Delete EQ peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationeqdetail/:locationeqdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationeqdetailid", "value": "", "type": "path", "description": "ID number of the location earthquake record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete EQ peril" }, { "info": { "name": "Create FL peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfldetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create FL peril" }, { "info": { "name": "Get FL peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfldetail/:locationfldetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfldetailid", "value": "", "type": "path", "description": "ID number of the location flood record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get FL peril" }, { "info": { "name": "Update FL peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfldetail/:locationfldetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfldetailid", "value": "", "type": "path", "description": "ID number of the location flood record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update FL peril" }, { "info": { "name": "Delete FL peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfldetail/:locationfldetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfldetailid", "value": "", "type": "path", "description": "ID number of the location flood record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete FL peril" }, { "info": { "name": "Create FR peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfrdetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create FR peril" }, { "info": { "name": "Get FR peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfrdetail/:locationfrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfrdetailid", "value": "", "type": "path", "description": "ID number of the location fire record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get FR peril" }, { "info": { "name": "Update FR peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfrdetail/:locationfrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfrdetailid", "value": "", "type": "path", "description": "ID number of the location fire record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update FR peril" }, { "info": { "name": "Delete FR peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationfrdetail/:locationfrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationfrdetailid", "value": "", "type": "path", "description": "ID number of the location fire record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete FR peril" }, { "info": { "name": "Create reinsurance cession", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/cession", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create reinsurance cession" }, { "info": { "name": "Get reinsurance cession", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get reinsurance cession" }, { "info": { "name": "Update reinsurance cession", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update reinsurance cession" }, { "info": { "name": "Delete reinsurance cession", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete reinsurance cession" }, { "info": { "name": "Create TO peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtodetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create TO peril" }, { "info": { "name": "Get TO peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtodetail/:locationtodetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtodetailid", "value": "", "type": "path", "description": "ID number of the location tornado record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get TO peril" }, { "info": { "name": "Update TO peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtodetail/:locationtodetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtodetailid", "value": "", "type": "path", "description": "ID number of the location tornado record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update TO peril" }, { "info": { "name": "Delete TO peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtodetail/:locationtodetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtodetailid", "value": "", "type": "path", "description": "ID number of the location tornado record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete TO peril" }, { "info": { "name": "Create TR peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtrdetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create TR peril" }, { "info": { "name": "Get TR peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtrdetail/:locationtrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtrdetailid", "value": "", "type": "path", "description": "ID number of the location terrorism record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get TR peril" }, { "info": { "name": "Update TR peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtrdetail/:locationtrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtrdetailid", "value": "", "type": "path", "description": "ID number of the location terrorism record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update TR peril" }, { "info": { "name": "Delete TR peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationtrdetail/:locationtrdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationtrdetailid", "value": "", "type": "path", "description": "ID number of the location terrorism record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete TR peril" }, { "info": { "name": "Create WC", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwcdetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create WC" }, { "info": { "name": "Get WC", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwcdetail/:locationwcdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwcdetailid", "value": "", "type": "path", "description": "ID number of the location worker compensation record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get WC" }, { "info": { "name": "Update WC", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwcdetail/:locationwcdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwcdetailid", "value": "", "type": "path", "description": "ID number of the location worker compensation record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update WC" }, { "info": { "name": "Delete WC", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwcdetail/:locationwcdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwcdetailid", "value": "", "type": "path", "description": "ID number of the location worker compensation record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete WC" }, { "info": { "name": "Create WS peril", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwsdetail", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create WS peril" }, { "info": { "name": "Get WS peril", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwsdetail/:locationwsdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwsdetailid", "value": "", "type": "path", "description": "ID number of the location windstorm record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get WS peril" }, { "info": { "name": "Update WS peril", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwsdetail/:locationwsdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwsdetailid", "value": "", "type": "path", "description": "ID number of the location windstorm record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update WS peril" }, { "info": { "name": "Delete WS peril", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/locationwsdetail/:locationwsdetailid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "locationwsdetailid", "value": "", "type": "path", "description": "ID number of the location windstorm record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete WS peril" }, { "info": { "name": "Create building attribute", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/buildingattribute", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create building attribute" }, { "info": { "name": "Get building attribute", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/buildingattribute/:buildingattributeid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "buildingattributeid", "value": "", "type": "path", "description": "ID number of the building attribute." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get building attribute" }, { "info": { "name": "Update building attribute", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/locations/:id/buildingattribute/:buildingattributeid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "buildingattributeid", "value": "", "type": "path", "description": "ID number of the location building attribute record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update building attribute" }, { "info": { "name": "Delete building attribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/locations/:id/buildingattribute/:buildingattributeid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "buildingattributeid", "value": "", "type": "path", "description": "ID number of the location building attribute record." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete building attribute" }, { "info": { "name": "Geocode address", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/geocode", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geocode address" }, { "info": { "name": "Geocode or hazard location", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/locations/:id/geocode", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geocode or hazard location" }, { "info": { "name": "Get policy conditions by location", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/locations/:id/policyconditions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy conditions by location" } ] }, { "info": { "name": "MetricsV1", "type": "folder" }, "items": [ { "info": { "name": "Get results", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results" }, { "info": { "name": "Delete result", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/analyses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete result" }, { "info": { "name": "Rename result", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/analyses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of analysis result. Must be valid analysis ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Rename result" }, { "info": { "name": "Delete result", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/analyses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete result" }, { "info": { "name": "Get region details", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/analysis-region", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get region details" }, { "info": { "name": "Get cedants by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/cedants", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get cedants by result" }, { "info": { "name": "Calculate climate change", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/climate-change", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of <> result." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Calculate climate change" }, { "info": { "name": "Convert result currency", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of <>." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert result currency" }, { "info": { "name": "Convert event rates and losses", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/convert-event-rate-loss", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert event rates and losses" }, { "info": { "name": "Get EP metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/ep", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "ID of treaty applied to result." }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metric. One of `ELT`, `EP`, or `STATS`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EP metrics" }, { "info": { "name": "Get EP interpolation results", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/ep/interpolate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "ID of treaty applied to result." }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "key", "value": "", "type": "query", "description": "Metric Key name" }, { "name": "value", "value": "", "type": "query", "description": "Metric Key value" }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metric. One of `ELT`, `EP`, or `STATS`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EP interpolation results" }, { "info": { "name": "Get ELT", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/elt", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page, maximum is _100000_. Default is _100_." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_." }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "eventIds", "value": "", "type": "query", "description": "IDs of events analyzed." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get ELT" }, { "info": { "name": "Get metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/metrics", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metrics. One of `ELT`, `EP`, `STATS`." }, { "name": "position", "value": "", "type": "query", "description": "Array of <>s." }, { "name": "granularity", "value": "", "type": "query", "description": "granularity." }, { "name": "epType", "value": "", "type": "query", "description": "ep Type." }, { "name": "returnPeriod", "value": "", "type": "query", "description": "returnPeriod." }, { "name": "filterCondition", "value": "", "type": "query", "description": "Filter condition." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics" }, { "info": { "name": "Get key losses", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/keylosses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get key losses" }, { "info": { "name": "Get location AAL", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/location-aal", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location AAL" }, { "info": { "name": "Convert financial perspectives", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/map-perspective", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert financial perspectives" }, { "info": { "name": "Calculate marginal impact report", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/marginal-impact", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of a portfolio-level <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Calculate marginal impact report" }, { "info": { "name": "Recalculate result with PATE", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/pate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of a <>." }, { "name": "groupInfoOnly", "value": "", "type": "query", "description": "Group info only" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Recalculate result with PATE" }, { "info": { "name": "Get financial perspectives", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/perspectives", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get financial perspectives" }, { "info": { "name": "Get PLT", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/plt", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page, maximum is _100000_. Default is _100_." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get PLT" }, { "info": { "name": "Recalculate result EP and statistics", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/rerun-ep", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number the <>." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Recalculate result EP and statistics" }, { "info": { "name": "Get sampled losses", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/sampledlosses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "events", "value": "", "type": "query", "description": "EventIds list" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get sampled losses" }, { "info": { "name": "Simulate PLT analysis", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/analyses/:id/simulate-losses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Simulate PLT analysis" }, { "info": { "name": "Get statistics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:id/stats", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get statistics" }, { "info": { "name": "Get treaties by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/treaties", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties by result" }, { "info": { "name": "Get treaty by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/analyses/:analysisID/treaty/:treatyID", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "treatyID", "value": "", "type": "path", "description": "Treaty ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaty by result" } ] }, { "info": { "name": "MetricsV2", "type": "folder" }, "items": [ { "info": { "name": "Get results", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses", "params": [ { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" }, { "name": "userName", "value": "", "type": "query", "description": "Name of <> that submitted the workflow." }, { "name": "runDate", "value": "", "type": "query", "description": "Date that the analysis was run." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results" }, { "info": { "name": "Delete results", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/analyses", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete results" }, { "info": { "name": "Rename result", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/analyses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result to be renamed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Rename result" }, { "info": { "name": "Delete result", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/analyses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete result" }, { "info": { "name": "Get region details", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/analysis-region", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get region details" }, { "info": { "name": "Get cedants by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/cedants", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get cedants by result" }, { "info": { "name": "Calculate climate change", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/climate-change", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of <> result." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Calculate climate change" }, { "info": { "name": "Convert event rates and losses", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/convert-event-rate-loss", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert event rates and losses" }, { "info": { "name": "Convert result currency", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert result currency" }, { "info": { "name": "Get ELT", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/elt", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page, maximum is _100000_. Default is _100_." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_." }, { "name": "treatyId", "value": "", "type": "query", "description": "ID of treaty applied to result." }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "eventIds", "value": "", "type": "query", "description": "IDs of events analyzed." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get ELT" }, { "info": { "name": "Get EP metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/ep", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "ID of treaty applied to result." }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metric. One of `ELT`, `EP`, or `STATS`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EP metrics" }, { "info": { "name": "Get EP interpolation results", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/ep/interpolate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "Exposure ID" }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "key", "value": "", "type": "query", "description": "Metric Key name" }, { "name": "value", "value": "", "type": "query", "description": "Metric Key value" }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metric. One of `ELT`, `EP`, or `STATS`." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get EP interpolation results" }, { "info": { "name": "Get key losses", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/keylosses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get key losses" }, { "info": { "name": "Get location AAL", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/location-aal", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location AAL" }, { "info": { "name": "Convert financial perspectives", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/map-perspective", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert financial perspectives" }, { "info": { "name": "Calculate marginal impact report", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/marginal-impact", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of a portfolio-level <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Calculate marginal impact report" }, { "info": { "name": "Get metrics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/metrics", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "metricType", "value": "", "type": "query", "description": "Type of metrics. One of `ELT`, `EP`, `STATS`." }, { "name": "position", "value": "", "type": "query", "description": "Array of <>s." }, { "name": "granularity", "value": "", "type": "query", "description": "granularity." }, { "name": "epType", "value": "", "type": "query", "description": "ep Type." }, { "name": "returnPeriod", "value": "", "type": "query", "description": "returnPeriod." }, { "name": "filterCondition", "value": "", "type": "query", "description": "Filter condition." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics" }, { "info": { "name": "Recalculate result with PATE", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/pate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the <>." }, { "name": "groupInfoOnly", "value": "", "type": "query", "description": "Group info only" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Recalculate result with PATE" }, { "info": { "name": "Delete PATE treaties", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/analyses/:id/pate-batch", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete PATE treaties" }, { "info": { "name": "Get PATE treaties", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/pate-treaties", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get PATE treaties" }, { "info": { "name": "Delete PATE treaties by result", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/pate-treaties", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete PATE treaties by result" }, { "info": { "name": "Get financial perspectives", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/perspectives", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get financial perspectives" }, { "info": { "name": "Get PLT", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/plt", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page, maximum is _100000_. Default is _100_." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_." }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get PLT" }, { "info": { "name": "Recalculate result EP and statistics", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/rerun-ep", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number the <>." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Recalculate result EP and statistics" }, { "info": { "name": "Get sampled losses", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/sampledlosses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss)." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" }, { "name": "events", "value": "", "type": "query", "description": "EventIds list" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get sampled losses" }, { "info": { "name": "Simulate PLT analysis", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/simulate-losses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of <>." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Simulate PLT analysis" }, { "info": { "name": "Get statistics", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:id/stats", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." }, { "name": "perspective", "value": "", "type": "query", "description": "Financial perspective." }, { "name": "treatyId", "value": "", "type": "query", "description": "Treaty ID" }, { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure analyzed." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location).\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get statistics" }, { "info": { "name": "Generate summary report", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/analyses/:id/summary_report", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of result." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generate summary report" }, { "info": { "name": "Get treaties by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/treaties", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties by result" }, { "info": { "name": "Get treaty by result", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/analyses/:analysisID/treaty/:treatyID", "params": [ { "name": "analysisID", "value": "", "type": "path", "description": "ID number of result." }, { "name": "treatyID", "value": "", "type": "path", "description": "Treaty ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaty by result" } ] }, { "info": { "name": "PateV1", "type": "folder" }, "items": [ { "info": { "name": "Create PATE treaty", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/pate-treaties", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create PATE treaty" }, { "info": { "name": "Get PATE treaty", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/pate-treaties/:pateId", "params": [ { "name": "pateId", "value": "", "type": "path", "description": "Pate ID of pate." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get PATE treaty" }, { "info": { "name": "Update PATE treaty", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/pate-treaties/:pateId", "params": [ { "name": "pateId", "value": "", "type": "path", "description": "ID of the PATE treaty to be updated." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update PATE treaty" }, { "info": { "name": "Delete PATE treaty", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/pate-treaties/:pateId", "params": [ { "name": "pateId", "value": "", "type": "path", "description": "ID number of the pate treaty." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete PATE treaty" } ] }, { "info": { "name": "PolicyV1", "type": "folder" }, "items": [ { "info": { "name": "Get policies", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policies" }, { "info": { "name": "Create policy", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create policy" }, { "info": { "name": "Copy policy", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/copy", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy policy" }, { "info": { "name": "Get policy", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy" }, { "info": { "name": "Update policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update policy" }, { "info": { "name": "Delete policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/policies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete policy" }, { "info": { "name": "Create reinsurance cession", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/:id/cession", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create reinsurance cession" }, { "info": { "name": "Get reinsurance cession", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the Cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get reinsurance cession" }, { "info": { "name": "Update reinsurance cession", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/policies/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the Cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update reinsurance cession" }, { "info": { "name": "Delete reinsurance cession", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/policies/:id/cession/:cessionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "cessionid", "value": "", "type": "path", "description": "ID number of the Cession." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete reinsurance cession" }, { "info": { "name": "Create policy coverage", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/:id/coverage", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create policy coverage" }, { "info": { "name": "Get policy coverage", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the Policy Coverage." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy coverage" }, { "info": { "name": "Update policy coverage", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/policies/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the Policy Coverage." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update policy coverage" }, { "info": { "name": "Delete policy coverage", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/policies/:id/coverage/:coverageid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "coverageid", "value": "", "type": "path", "description": "ID number of the Policy Coverage." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete policy coverage" }, { "info": { "name": "Create policy condition", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create policy condition" }, { "info": { "name": "Get policy condition", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy condition" }, { "info": { "name": "Update policy condition", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update policy condition" }, { "info": { "name": "Delete policy condition", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete policy condition" }, { "info": { "name": "Back fill policy condition", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/backfill", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Back fill policy condition" }, { "info": { "name": "Create policy condition criteria", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/criteria", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create policy condition criteria" }, { "info": { "name": "Get policy condition criteria", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/criteria/:criteriaid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "criteriaid", "value": "", "type": "path", "description": "ID number of the Policy Condition Criteria." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy condition criteria" }, { "info": { "name": "Update policy condition criteria", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/criteria/:criteriaid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "criteriaid", "value": "", "type": "path", "description": "ID number of the Policy Condition Criteria." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update policy condition criteria" }, { "info": { "name": "Delete policy condition criteria", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/criteria/:criteriaid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "criteriaid", "value": "", "type": "path", "description": "ID number of the Policy Condition Criteria." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete policy condition criteria" }, { "info": { "name": "Get location conditions", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/policycondition/:conditionid/locationconditions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "conditionid", "value": "", "type": "path", "description": "ID number of the Policy Condition." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location conditions" }, { "info": { "name": "Get policy condition", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/conditions/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy condition" }, { "info": { "name": "Get surplus treaties", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policies/:id/surplustreaties", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get surplus treaties" } ] }, { "info": { "name": "Policy ConditionV1", "type": "folder" }, "items": [ { "info": { "name": "Get policy conditions", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/policyconditions", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get policy conditions" } ] }, { "info": { "name": "PortfolioV1", "type": "folder" }, "items": [ { "info": { "name": "Get portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolios" }, { "info": { "name": "Create portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create portfolio" }, { "info": { "name": "Get portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio" }, { "info": { "name": "Update portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update portfolio" }, { "info": { "name": "Delete portfolio", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "deleteType", "value": "", "type": "query", "description": "The scope of the data deleted: `PORTFOLIO_INFO`, `PORTFOLIO_ALL_ACCOUNTS`, or `PORTFOLIO_EXCEPT_ACCOUNTS`" }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete portfolio" }, { "info": { "name": "Get accounts by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/accounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get accounts by portfolio" }, { "info": { "name": "Manage accounts by portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/portfolios/:id/accounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage accounts by portfolio" }, { "info": { "name": "Get analyses by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get analyses by portfolio" }, { "info": { "name": "Convert currency by portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by portfolio" }, { "info": { "name": "Get portfolio locations", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/coordinate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "latitude", "value": "", "type": "query", "description": "Latitude coordinates." }, { "name": "longitude", "value": "", "type": "query", "description": "Longitude coordinates." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio locations" }, { "info": { "name": "Get location coordinates by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/coordinates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location coordinates by portfolio" }, { "info": { "name": "Copy portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy portfolio" }, { "info": { "name": "Count portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count portfolios" }, { "info": { "name": "Manage filtered accounts by portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/portfolios/:id/filteredaccounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage filtered accounts by portfolio" }, { "info": { "name": "Geohazard portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios/:id/geohaz", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geohazard portfolio" }, { "info": { "name": "Get metrics by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by portfolio" }, { "info": { "name": "Analyze portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze portfolio" }, { "info": { "name": "Get portfolio reports", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/portfolios/:id/reports", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio reports" }, { "info": { "name": "Generate summary report by portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/portfolios/:id/summary_report", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generate summary report by portfolio" }, { "info": { "name": "Manage portfolio exposures in batch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/exposurebatches", "params": [ { "name": "operation", "value": "", "type": "query", "description": "Operation of batch resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage portfolio exposures in batch" } ] }, { "info": { "name": "PortfolioV2", "type": "folder" }, "items": [ { "info": { "name": "Get portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolios" }, { "info": { "name": "Create portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create portfolio" }, { "info": { "name": "Count portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count portfolios" }, { "info": { "name": "Get portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio" }, { "info": { "name": "Update portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update portfolio" }, { "info": { "name": "Delete portfolio", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v2/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "deleteType", "value": "", "type": "query", "description": "The scope of the data deleted: `PORTFOLIO_INFO`, `PORTFOLIO_ALL_ACCOUNTS`, or `PORTFOLIO_EXCEPT_ACCOUNTS`" }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete portfolio" }, { "info": { "name": "Get accounts by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/accounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get accounts by portfolio" }, { "info": { "name": "Manage accounts by portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/portfolios/:id/accounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage accounts by portfolio" }, { "info": { "name": "Get results by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/analyses", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page returned records. By default, _0_." }, { "name": "userName", "value": "", "type": "query", "description": "Name of <> that submitted the workflow." }, { "name": "runDate", "value": "", "type": "query", "description": "Date that the analysis was run." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get results by portfolio" }, { "info": { "name": "Convert currency by portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by portfolio" }, { "info": { "name": "Get portfolio locations", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/coordinate", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "latitude", "value": "", "type": "query", "description": "Latitude coordinates." }, { "name": "longitude", "value": "", "type": "query", "description": "Longitude coordinates." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio locations" }, { "info": { "name": "Get location coordinates by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/coordinates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get location coordinates by portfolio" }, { "info": { "name": "Manage filtered accounts by portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v2/portfolios/:id/filteredaccounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage filtered accounts by portfolio" }, { "info": { "name": "Copy portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy portfolio" }, { "info": { "name": "Geohazard portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios/:id/geohaz", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Geohazard portfolio" }, { "info": { "name": "Get metrics by portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get metrics by portfolio" }, { "info": { "name": "Analyze portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios/:id/process", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Analyze portfolio" }, { "info": { "name": "Get portfolio reports", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v2/portfolios/:id/reports", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page of returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get portfolio reports" }, { "info": { "name": "Generate summary report by portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/portfolios/:id/summary_report", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the portfolio." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generate summary report by portfolio" }, { "info": { "name": "Manage portfolio exposures in batch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v2/exposurebatches", "params": [ { "name": "operation", "value": "", "type": "query", "description": "Operation of batch resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage portfolio exposures in batch" } ] }, { "info": { "name": "ProducerV1", "type": "folder" }, "items": [ { "info": { "name": "Get producers", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/producers", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page returned records. By default, _0_." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get producers" }, { "info": { "name": "Create producer", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/producers", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create producer" }, { "info": { "name": "Get producer by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/producers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Producer." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get producer by ID" }, { "info": { "name": "Update producer", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/producers/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update producer" }, { "info": { "name": "Delete producer", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/producers/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID number of the location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete producer" } ] }, { "info": { "name": "ReportsV1", "type": "folder" }, "items": [ { "info": { "name": "Get report", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the report." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get report" }, { "info": { "name": "Update report", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of report." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update report" }, { "info": { "name": "Get reports", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/reports", "params": [ { "name": "exposureId", "value": "", "type": "query", "description": "ID number of exposure." }, { "name": "exposureType", "value": "", "type": "query", "description": "Type of exposure, e.g. `ACCOUNT`, `PORTFOLIO`." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify `ASC` to display the results in alphabetical or numerical ascending order or `DESC` to display the results in descending order.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages that are offset before the initial page of records returned. By default, _0_." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get reports" } ] }, { "info": { "name": "Step PolicyV1", "type": "folder" }, "items": [ { "info": { "name": "Get step policies", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/steppolicies", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page returned records. By default, _0_." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get step policies" }, { "info": { "name": "Create step policy", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/steppolicies", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create step policy" }, { "info": { "name": "Copy step policy", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/steppolicies/copy", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy step policy" }, { "info": { "name": "Get step policy", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/steppolicies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the step policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get step policy" }, { "info": { "name": "Update step policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/steppolicies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the step policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update step policy" }, { "info": { "name": "Delete step policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/steppolicies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the step policy." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete step policy" } ] }, { "info": { "name": "TreatyV1", "type": "folder" }, "items": [ { "info": { "name": "Get treaties", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page returned records. By default, _0_." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties" }, { "info": { "name": "Create treaty", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create treaty" }, { "info": { "name": "Count treaties", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/count", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Count treaties" }, { "info": { "name": "Get treaties by type", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/getbytype", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "type", "value": "", "type": "query", "description": "Type of treaty." }, { "name": "exposuretype", "value": "", "type": "query", "description": "Type of exposure. Specify 'POL' for policy abd 'LOC' for location." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaties by type" }, { "info": { "name": "Get treaty", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get treaty" }, { "info": { "name": "Update treaty", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/treaties/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the treaty." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update treaty" }, { "info": { "name": "Delete treaty", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/treaties/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "Treaty Id." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete treaty" }, { "info": { "name": "Convert currency by treaty", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties/:id/convertcurrency", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the treaty." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert currency by treaty" }, { "info": { "name": "Copy treaty", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties/:id/copy", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the treaty." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Copy treaty" }, { "info": { "name": "Create LOB by treaty", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties/:id/lob", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the location." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create LOB by treaty" }, { "info": { "name": "Get LOB by treaty", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/:id/lob/:lobid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the treaty." }, { "name": "lobid", "value": "", "type": "path", "description": "ID number of the lob." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get LOB by treaty" }, { "info": { "name": "Delete treaty LOB", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/treaties/:id/lob/:lobid", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of the treaty." }, { "name": "lobid", "value": "", "type": "path", "description": "ID number of the lob." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete treaty LOB" }, { "info": { "name": "Manage treaty LOBs in batch", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties/lob/batch", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Manage treaty LOBs in batch" }, { "info": { "name": "Get loss occurrences by treaty", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/:treatyId/lossoccurrences", "params": [ { "name": "treatyId", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get loss occurrences by treaty" }, { "info": { "name": "Create loss occurrence", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/treaties/:treatyId/lossoccurrences", "params": [ { "name": "treatyId", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create loss occurrence" }, { "info": { "name": "Get loss occurrence by treaty", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/treaties/:treatyId/lossoccurrences/:lossOccurrenceId", "params": [ { "name": "treatyId", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "lossOccurrenceId", "value": "", "type": "path", "description": "Treaty loss occurrence Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get loss occurrence by treaty" }, { "info": { "name": "Update loss occurrence", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/treaties/:treatyId/lossoccurrences/:lossOccurrenceId", "params": [ { "name": "treatyId", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "lossOccurrenceId", "value": "", "type": "path", "description": "Treaty loss occurrence Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update loss occurrence" }, { "info": { "name": "Delete loss occurrence", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/treaties/:treatyId/lossoccurrences/:lossOccurrenceId", "params": [ { "name": "treatyId", "value": "", "type": "path", "description": "Treaty Id." }, { "name": "lossOccurrenceId", "value": "", "type": "path", "description": "Treaty loss occurrence Id." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete loss occurrence" } ] }, { "info": { "name": "UnderwriterV1", "type": "folder" }, "items": [ { "info": { "name": "Get underwriters", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/underwriters", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records returned per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages offset before the first page returned records. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get underwriters" }, { "info": { "name": "Create underwriter", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/underwriters", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create underwriter" }, { "info": { "name": "Get underwriter", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/underwriters/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the underwriter." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get underwriter" }, { "info": { "name": "Update underwriter", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/underwriters/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the underwriter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update underwriter" }, { "info": { "name": "Delete underwriter", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/underwriters/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the underwriter." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete underwriter" } ] }, { "info": { "name": "UtilityV1", "type": "folder" }, "items": [ { "info": { "name": "Convert policy condition to query", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/utils/convert/criteriatoquery", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert policy condition to query" }, { "info": { "name": "Convert portfolio condition to query", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/utils/convert/portfoliocriteriatoquery", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Convert portfolio condition to query" }, { "info": { "name": "Get facultataives", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/faclayers", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "q", "value": "", "type": "query", "description": "Filters query results by evaluating the value of expressions. Supports four types of operators:\n* Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`\n* Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name=\"xyz\"` , `id=100 OR type=\"abc\"`\n* List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN (\"abc\",\"xyz\")`\n* Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE \"abc \"` , `type NOT LIKE \" xyz* \"`\nTo learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data)." }, { "name": "sort", "value": "", "type": "query", "description": "Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to display per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages that are offset before the initial page of records returned. By default, _0_.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get facultataives" }, { "info": { "name": "Create facultative", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/faclayers", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Create facultative" }, { "info": { "name": "Get facultative by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/faclayers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the faclutative." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get facultative by ID" }, { "info": { "name": "Update facultative", "type": "http" }, "http": { "method": "PUT", "url": "https://{host}/riskmodeler/v1/faclayers/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the facultative." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update facultative" }, { "info": { "name": "Delete facultative", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/faclayers/:id", "params": [ { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." }, { "name": "id", "value": "", "type": "path", "description": "ID of the facultative." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Delete facultative" }, { "info": { "name": "Update exposures dry run", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/globaledit/dryrun", "params": [ { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure type: ACCOUNT or PORTFOLIO." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ] }, "docs": "Update exposures dry run" }, { "info": { "name": "Update exposures", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/globaledit", "params": [ { "name": "exposureId", "value": "", "type": "query", "description": "ID of exposure." }, { "name": "exposureType", "value": "", "type": "query", "description": "Exposure type: `ACCOUNT` or `PORTFOLIO`." }, { "name": "datasource", "value": "", "type": "query", "description": "Name of the EDM." } ] }, "docs": "Update exposures" } ] }, { "info": { "name": "WorkflowsV1", "type": "folder" }, "items": [ { "info": { "name": "Get workflows", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/workflows", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of workflow IDs." }, { "name": "limit", "value": "", "type": "query", "description": "Number of records displayed per page." }, { "name": "offset", "value": "", "type": "query", "description": "Number of pages that are offset before the initial page of records returned. By default, _0_.\n" }, { "name": "status", "value": "", "type": "query", "description": "Status of the workflow, e.g. `QUEUED`,`RUNNING`, `FINISHED`, `FAILED`, `CANCELLED`, `PENDING`, `CANCELLING`, `CANCEL_REQUESTED`.\n" }, { "name": "workflowtype", "value": "", "type": "query", "description": "Type of the workflow, e.g. `ANALYTICS_JOB`." }, { "name": "from", "value": "", "type": "query", "description": "Timestamp of earliest submission date." }, { "name": "to", "value": "", "type": "query", "description": "Timestamp of latest submission date." }, { "name": "username", "value": "", "type": "query", "description": "Name of <> that submitted the workflow." }, { "name": "workflowname", "value": "", "type": "query", "description": "Name of workflow." }, { "name": "sortby", "value": "", "type": "query", "description": "Attribute on which to sort returned records." }, { "name": "sortorder", "value": "", "type": "query", "description": "Sort order (alphabetical or numerical) of returned records. One of `ASC` or `DESC`.\n" }, { "name": "scheduled", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get workflows" }, { "info": { "name": "Process user-defined workflow", "type": "http" }, "http": { "method": "POST", "url": "https://{host}/riskmodeler/v1/workflows", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Process user-defined workflow" }, { "info": { "name": "Get workflow or operation", "type": "http" }, "http": { "method": "GET", "url": "https://{host}/riskmodeler/v1/workflows/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of a workflow job or workflow operation." }, { "name": "parent", "value": "", "type": "query", "description": "ID number of the <> that is the parent of the workflow operation.\n" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Get workflow or operation" }, { "info": { "name": "Cancel workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://{host}/riskmodeler/v1/workflows/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID number of a workflow job." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Cancel workflow" } ] } ], "bundled": true }