{"openapi":"3.0.2","info":{"title":"Risk Data API","version":"2026.03.b"},"servers":[{"url":"https://{host}/platform/riskdata/v1","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com"}}}],"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["curl","json","python","java","csharp","node"],"proxy-enabled":true,"samples-enabled":true},"paths":{"/exposures/{exposureId}/accounts":{"get":{"tags":["Accounts"],"summary":"Search accounts","description":" ","operationId":"getAccounts","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `accountId`, `accountName`, `accountNumber`, `branchName`, `cedantName`, `locationsCount`, `ownerName`, `policyExpirationDate`, `producerName`, `reportsCount`, `resultsCount`, `stampDate`, `underwriterName`, `userId1`, `userId2`, `userId3`, `userId4`, `userText1`, `userText2`, `tagIds`. \n\nOperators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#accounts).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `accountId`, `accountName`, `accountNumber`, `branchName`, `cedantName`, `locationsCount`, `ownerName`, `policyExpirationDate`, `producerName`, `reportsCount`, `resultsCount`, `stampDate`, `underwriterName`, `userId1`, `userId2`, `userId3`, `userId4`, `userText1`, `userText2`\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}},{"name":"allowDeepFilters","in":"query","description":"If `true`, this search was triggered from portfolio starting at _0_","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountSearch"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Accounts"],"summary":"Create account","description":" ","operationId":"createAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Account resource","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}":{"get":{"tags":["Accounts"],"summary":"Get account","description":" ","operationId":"getAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Accounts"],"summary":"Update account","description":" ","operationId":"updateAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}},"required":true},"responses":{"204":{"description":"Validation updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Accounts"],"summary":"Delete account","description":" ","operationId":"deleteAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `DELETE_ACCOUNT` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `DELETE_ACCOUNT` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/validatemedia":{"get":{"tags":["Accounts"],"summary":"Download account validation file","description":" ","operationId":"downloadValidationAccountFile","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}},"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/metrics":{"get":{"tags":["Accounts"],"summary":"Get account metadata","description":" ","operationId":"getAccountMetrics","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Metrics for a specified account are successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMetrics"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/update-metrics":{"post":{"tags":["Accounts"],"operationId":"updateAccountMetrics","summary":"Refresh account metadata","description":"","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"202":{"description":"Accepted.\n\nA `UPDATE_METRICS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `UPDATE_METRICS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/countries":{"get":{"tags":["Accounts"],"summary":"Get countries by account","description":" ","operationId":"getCountriesByAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"List of countries retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CountryMetrics"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/surplustreaties-location":{"get":{"tags":["Accounts"],"summary":"Get surplus treaties by account","description":" ","operationId":"getLocationSurplusTreaties","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Treaty"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/sites":{"get":{"tags":["Accounts"],"summary":"Get sites by account","description":" ","operationId":"getSiteNames","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"List of site names retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/accounts/{id}/validate":{"get":{"tags":["Accounts"],"summary":"Validate account","description":" ","operationId":"validateAccount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of account.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationConditionValidationInfo"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios":{"get":{"tags":["Aggregate Portfolios"],"summary":"Search aggregate portfolios","description":" ","operationId":"searchAggregatePortfolios","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `aggregatePortfolioId`, `aggregatePortfolioName`, `aggregatePortfolioNumber`, `cedantId`, `cedantName`, `createDate`, `currency`, `ownerName`, `source`, `tagIds`\n\n| Property                 | Data Type    | Comparison                      | List | \n| :----------------------- | :----------- | :------------------------------ | :------------- | \n| `aggregatePortfolioId` | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `aggregatePortfolioName` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `aggregatePortfolioNumber`  | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `cedantId` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `cedantName` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `createDate` | `YYYY-MM-DD`     | `=`, `!=`, `>`, `<`, `>=`, `<=`   | `IN`, `NOT IN` | \n| `currency` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `ownerName` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `source` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `tagIds` | `Array`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n\nUse the `AND` and `OR` logical operators to form compound queries. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#aggregate-portfolios).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties:`aggregatePortfolioId`, `aggregatePortfolioName`, `aggregatePortfolioNumber`, `cedantId`, `cedantName`, `createDate` `currency`, `ownerName`, `source`.  See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregatePortfolioSearchItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Aggregate Portfolios"],"summary":"Create aggregate portfolio","description":" ","operationId":"createAggregatePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatePortfolio"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Aggregate portfolio resource","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios/{id}":{"get":{"tags":["Aggregate Portfolios"],"summary":"Get aggregate portfolio","description":" ","operationId":"getAggregatePortfolioById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatePortfolioSearchItem"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Aggregate Portfolios"],"summary":"Update aggregate portfolio","description":" ","operationId":"updateAggregatePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatePortfolio"}}},"required":true},"responses":{"204":{"description":"Aggregate portfolio successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Aggregate Portfolios"],"summary":"Delete aggregate portfolio","description":" ","operationId":"deleteAggregatePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `DELETE_AGGREGATE_PORTFOLIO` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `DELETE_AGGREGATE_PORTFOLIO` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios/{id}/metrics":{"get":{"tags":["Aggregate Portfolios"],"summary":"Get aggregate portfolio metadata","description":" ","operationId":"getAggregatePortfolioMetrics","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatePortfolioMetrics"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportolios/{id}/update-metrics":{"post":{"tags":["Aggregate Portfolios"],"summary":"Refresh aggregate portfolio metadata","description":" ","operationId":"updateAggregatePortfolioMetrics","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"202":{"description":"Accepted.\n\nA `UPDATE_METRICS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `UPDATE_METRICS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios/{id}/treaties":{"get":{"tags":["Aggregate Portfolios"],"summary":"Get treaties by aggregate portfolio","description":" ","operationId":"getAggregatePortfolioTreaties","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Treaty"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios/{id}/countries":{"get":{"tags":["Aggregate Portfolios"],"summary":"Get countries by aggregate portfolio","description":" ","operationId":"getCountriesByAggregatePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregatePortfolioCountryMetrics"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/aggregateportfolios/{id}/aggregate-exposures-lists":{"get":{"tags":["Aggregate Portfolios"],"summary":"Get aggregate exposures values","description":" ","operationId":"searchAggregateExposures","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of aggregate portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"countryCode","in":"query","description":"Country to filter by.","required":true,"schema":{"type":"string"}},{"name":"resolution","in":"query","description":"Resolution to filter by.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregateExposuresList"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses":{"get":{"tags":["Analyses"],"summary":"Search analysis results","operationId":"getAnalyses","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property                 | Data Type    | Comparison                      | List | \n| :----------------------- | :----------- | :------------------------------ | :------------- | \n| `analysisFramework`      | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `analysisId`             | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `analysisName`           | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `analysisType`           | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `appAnalysisId`          | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `createDate`             | `YYYY-MM-DD` | `=`, `!=`, `>`, `<`, `>=`, `<=` |                | \n| `currencyCode`           | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `currencyName`           | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `description`            | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `engineId`               | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `engineType`             | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `engineSubTypeId`        | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `engineSubTypeCode`      | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |  \n| `engineVersion`          | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `exposureName`           | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `exposureResourceTypeId` | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `exposureSetGuid`        | `String`     | `=`, `!=`                       | `IN`, `NOT IN` | \n| `insuranceTypeId`        | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `lossAmplificationId`    | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `modeId`                 | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `peril`                  | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `perilCode`              | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `region`                 | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `regionCode`             | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `securableType`          | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `secuarableId`           | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `sourceRdmName`          | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `securableId`            | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `securableType`          | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `statusId`               | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `subperil`               | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` | \n| `subPerilId`             | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n| `typeId`                 | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `tagIds`                 | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n| `username`               | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `vulnerabilityCurveId`   | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` | \n\nUse the `AND`, `OR` logical operators to form compound queries. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `analysisFramework`, `analysisId`, `analysisName`, `analysisType`, `createDate`, `currencyCode`, `currencyName`, `description`, `engineType`, `engineVersion`, `exposureName`, `exposureResourceTypeId`, `exposureSetGuid`, `peril`, `region`, `securableId`, `securableType`, `sourceRdmName`, `subperil`, `username`. \n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page; maximum is 1000. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchAnalysisResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}":{"get":{"tags":["Analyses"],"summary":"Get analysis result","operationId":"getAnalysisById","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"include","in":"query","description":"Property to include in response object. Property is not returned unless specified.\n\nSupports `resourcegroupid` property.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAnalysisResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Analyses"],"summary":"Rename analysis result","description":" ","operationId":"runRenameAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result to be renamed.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnalysisInfo"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `RENAME_ANALYSIS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `RENAME_ANALYSIS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Analyses"],"summary":"Delete analysis result","description":" ","operationId":"deleteAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Analysis result deleted successfully"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/elt":{"get":{"tags":["Analyses"],"summary":"Get ELT","operationId":"getEventLossTableResults","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"array","items":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","required":true,"example":26113,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n* If `exposureResourceType` is `POLICY`, supports filtering by `exposureResourceId` using the `IN` operator only.\n* If `exposureResoruceType` is any other exposure type, supports filtering by `eventId` or `exposureResourceId` using the `=` or `IN` operators.\n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string","default":""}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\n\n* If `exposureResourceType` is `POLICY`, supports sorting by `eventId`, `expValue`, `exposureResourceId`, `exposureResourceNumber`, `perspectiveCode`, `positionValue`, `rate`, `stdDevC`, `stdDevI`\n* If `exposureResoruceType` is any other exposure type, sorting is not supported.\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventLossItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/plt":{"get":{"tags":["Analyses"],"summary":"Get PLT","operationId":"getPeriodLossTableResults","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n Supports filtering by `eventId` using the `=` or `IN` operator. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination). maximum is 100000","schema":{"maximum":100000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeriodLossItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/sampled-losses":{"get":{"tags":["Analyses"],"summary":"Get non-EP sampled losses","operationId":"getSampledLoss","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}},{"name":"lossSampleLimit","in":"query","description":"Number of records returned. By default, _100_.","schema":{"type":"integer","format":"int32"}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","example":26113,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"events","in":"query","description":"List of event IDs, e.g. _1,23,324_","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SampledLossItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/ep":{"get":{"tags":["Analyses"],"summary":"Get EP metrics","operationId":"getEPMetricsByAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.\n\nSupports ALM, DLM, or HD analysis results.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"array","items":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.\n\nRequired for DLM analysis. Required if `exposureResourceType` is `ACCOUNT`.","example":26113,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n* If `exposureResourceType` is `POLICY`, supports filtering by `epType` using `=` operator. \n* If `exposureResourceType` is `POLICY` and no `exposureResourceId` is specified, supports filtering by `returnPeriod` using singular `IN` operator for HD/DLM results.\n* If `exposureResoruceType` is any other exposure type, supports filtering by `epType` or `exposureResourceId` using the `=` or `IN` operators.\n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\n\n* If `exposureResourceType` is `POLICY`, supports sorting by `epType`, `exposureResourceId`, `exposureResourceNumber`, `perspectiveCode`, `positionValue`\n* If `exposureResoruceType` is any other exposure type, sorting is not supported.\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EpMetricsOutput"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/ep/interpolate":{"get":{"tags":["Analyses"],"summary":"Get interpolated EP metrics","description":" ","operationId":"getEPInterpolateMetricResults","parameters":[{"name":"analysisId","in":"path","description":"ID of HD EP analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","example":26113,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"keyName","in":"query","description":"Name of property interpolated into PLT. One of `RETURNPERIOD` or `CRITICALPROBABILITY`.","required":true,"schema":{"type":"string"}},{"name":"keyValue","in":"query","description":"Value of the interpolated `keyName` property. Must be a positive number.","schema":{"type":"number","format":"double"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EpInterpolate"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/imported-rdms":{"get":{"tags":["Analyses"],"summary":"Search imported RDMs","operationId":"getImportedRDMs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                  | Comparison                 | List          | \n| ------------------------- | -------------------------- | ------------- | \n|`rdmName`                  |`=` `!=` `LIKE`  `NOT LIKE` |`IN` `NOT IN`  |\n|`exposureName`             |`=` `!=` `LIKE`  `NOT LIKE` |`IN` `NOT IN`  |\n\nThis parameter also supports logical operators (`AND`, `OR`) for defining compound expressions. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `rdmName`, `exposureName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","default":100,"maximum":1000}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"rdmName":{"type":"string"},"exposureName":{"type":"string","nullable":true}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/marginal-ep":{"get":{"tags":["Analyses"],"summary":"Get marginal EP metrics","operationId":"getMarginalEpMetrics","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"array","items":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}}},{"name":"granularity","in":"query","description":"Level of detail of metrics returned. One of `ACCOUNT` or `POLICY`","required":true,"schema":{"type":"array","items":{"type":"string","default":"POLICY","enum":["ACCOUNT","POLICY"]}}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n Supports filtering by `epType` or `returnPeriod` using the `=` and `IN` operators. \n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\n\nSupported properties: `ep`, `epType`, `policyId`, `policyNumber`, `position`, `positionValue`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination). maximum is 1000","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MarginalEp"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/stats":{"get":{"tags":["Analyses"],"summary":"Get EP statistics","operationId":"getStatisticsResults","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"array","items":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","example":26113,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. See [Filtering Responses](doc:response-filtering).\n\n* If `exposureResourceType` is `POLICY`, supports filtering by `exposureResourceId` using the `=` or `IN` operators .\n* If `exposureResourceType` is any other exposure type, filtering is not supported. \n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\n\n* If `exposureResourceType` is `POLICY`, supports sorting by `activation`, `cv`, `exhaustion`, `exposureResourceId`, `exposureResourceNumber`, `limit`, `netPurePremium`, `perspectiveCode`, `premium`, `purePremium`, `totalLossRatio`, `totalStdDev`.\n* If `exposureResoruceType` is any other exposure type, sorting is not supported.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StatisticsItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/key-losses":{"get":{"tags":["Analyses"],"summary":"Get non-EP statistics","operationId":"getNonEpKeyLoss","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}},{"name":"exposureResourceId","in":"query","description":"ID of exposure resource.","schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","required":true,"schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}},{"name":"events","in":"query","description":"List of event IDs, e.g. _1,23,324_","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyLossItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/key-event-stats":{"get":{"tags":["Analyses"],"summary":"Get non-EP statistics by terrorism event","operationId":"getKeyEventStats","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property                 | Data Type    | Comparison                      | List | \n| :----------------------- | :----------- | :------------------------------ | :------------- | \n| `eventId`                | `int64`      | `=`                             | `IN`           | \n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Supports sorting by `eventId` only. Sort order defined by one of `ASC` or `DESC`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination). Maximum is _1000_","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KeyEventStatItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/marginal-stats":{"get":{"tags":["Analyses"],"summary":"Get marginal statistics","operationId":"getMarginalStatsMetrics","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  ","required":true,"schema":{"type":"array","items":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}}},{"name":"granularity","in":"query","description":"Level of detail of statistics returned. One of `ACCOUNT` or `POLICY`","required":true,"schema":{"type":"array","items":{"type":"string","default":"POLICY","enum":["ACCOUNT","POLICY"]}}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination). maximum is _1000_","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MarginalStats"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/location-aal":{"get":{"tags":["Analyses"],"summary":"Get location-level statistics","operationId":"getAALMetrics","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"perspectiveCode","in":"query","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n","required":true,"schema":{"type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\n\nSupported properties: `aal`, `cv`, `locationId`, `stdDev`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"aal DESC"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination). maximum is 1000","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationAal"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/bulk-delete":{"post":{"tags":["Analyses"],"summary":"Bulk delete analysis results","operationId":"bulkDeleteAnalyses","requestBody":{"content":{"application/json":{"schema":{"maxItems":100,"minItems":1,"type":"array","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"204":{"description":"A list of analyses deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/marginal-impact":{"post":{"tags":["Analyses"],"summary":"Calculate marginal impact","operationId":"marginalImpact","parameters":[{"name":"analysisId","in":"path","description":"ID of portfolio-level <<glossary:reference analysis>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarginalImpactInput"}}}},"responses":{"202":{"description":"Accepted.\n\nA `MARGINAL_IMPACT` or `HD_MARGINAL_IMPACT` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of marginal impact job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/download-rollup-contributory-metrics":{"post":{"tags":["Rollup Analyses"],"summary":"Download rollup contributory metrics","operationId":"downloadRollupContributoryMetrics","parameters":[{"name":"analysisId","in":"path","description":"ID of business hierarchy <<glossary:rollup analysis>>. ","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadRollupContributoryMetricsRequest"}}}},"responses":{"200":{"description":"Success.\n\nReturns an array of download URLs for rollup contributory metrics. Returns an empty array if the analysis does not have rollup contributory metrics.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DownloadRollupContributoryMetricsResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/map-perspective":{"post":{"tags":["Analyses"],"summary":"Convert financial perspectives","description":" ","operationId":"mapPerspective","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result on which you want to run Map Perspective workflow. Should be valid analysis ID.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapPerspectiveInput"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `MAP_PERSPECTIVE` or `HD_MAP_PERSPECTIVE` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of map perspective job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/rerun-ep":{"post":{"tags":["Analyses"],"summary":"Recalculate EP and statistics","description":" ","operationId":"reRunEp","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result on which you want to run Rerun Ep workflow. Should be valid analysis id.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `RERUN_EP` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `RERUN_EP` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/climate-change":{"post":{"tags":["Analyses"],"summary":"Calculate climate change","description":" ","operationId":"runClimateChange","parameters":[{"name":"analysisId","in":"path","description":"ID of <<glossary:reference analysis>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ClimateChangeRcp"},{"$ref":"#/components/schemas/ClimateChangeSsp"}],"discriminator":{"propertyName":"type","mapping":{"rcp":"#/components/schemas/ClimateChangeRcp","ssp":"#/components/schemas/ClimateChangeSsp"}}}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `CLIMATE_CHANGE` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `CLIMATE_CHANGE` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/simulate-losses":{"post":{"tags":["Analyses"],"summary":"Simulate PLT analysis","description":" ","operationId":"runELTToPLTConversion","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result on which you want to run ELT to PLT conversion workflow. Should be valid analysis ID.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateEltToPlt"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `SIMULATE_LOSSES` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `SIMULATE_LOSSES` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/convert-plt-to-elt":{"post":{"tags":["Analyses"],"summary":"Convert PLT to ELT Analysis","operationId":"convertPltToElt","parameters":[{"name":"analysisId","in":"path","description":"ID of <<glossary:reference analysis>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `PLT_TO_ELT` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `PLT_TO_ELT` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/pate":{"post":{"tags":["Analyses"],"summary":"Recalculate with PATE","description":" ","operationId":"processPate","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result or analysis group that is the <<glossary:reference analysis>> for PATE.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"groupInfoOnly","in":"query","description":"Scope of PATE analysis result if the reference analysis result is an analysis group. May recalculate group-level statistics only or both group-level statistics and per-analysis statistics. \n\n* If `true`, recalculates group-level statistics only. DLM or HD analyses. \n* If `false`, recalculates both group-level statistics and per-analysis statistics. DLM analyses only.  ","schema":{"type":"boolean","default":true}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PateInput"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `PATE` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `PATE` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/convert-event-rate-loss":{"post":{"tags":["Analyses"],"summary":"Convert event rates and losses","description":" ","operationId":"convertAnalysisEvent","parameters":[{"name":"analysisId","in":"path","description":"ID of EP analysis result to recalculate.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertEventInput"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `CONVERT_EVENT_RATE_LOSS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `CONVERT_EVENT_RATE_LOSS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/update-tags":{"post":{"tags":["Analyses"],"summary":"Update tags by result","description":" ","operationId":"updateAnalysisTags","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json:":{"schema":{"$ref":"#/components/schemas/DataTagEntity"}}},"required":true},"responses":{"204":{"description":"Data tags analysis result successfully updated."},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/perspectives":{"get":{"tags":["Analyses"],"summary":"Get financial perspectives","operationId":"getPerspectivesForAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"exposureResourceType","in":"query","description":"Type of exposure.","schema":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Perspective"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/regions":{"get":{"tags":["Analyses"],"summary":"Get regions by analysis result","operationId":"getAnalysisRegions","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalysisRegion"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/cedants":{"get":{"tags":["Analyses"],"summary":"Get cedants by analysis result","operationId":"getCedants","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n Supports filtering by `perspectiveCode` using the `=` operator only. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CedantInfo"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/treaties":{"get":{"tags":["Analyses"],"summary":"Get treaties by analysis result","operationId":"getTreatiesList","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Number of records returned per page; maximum is 1000. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalysisTreaty"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/treaties/{treatyId}":{"get":{"tags":["Analyses"],"summary":"Get treaty by analysis result","description":" ","operationId":"getTreatyById","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"treatyId","in":"path","description":"ID of treaty.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisTreaty"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/rollup-pricing-stats":{"get":{"summary":"Get rollup pricing statistics","operationId":"getAnalysisPricingStats","tags":["Rollup Analyses"],"parameters":[{"name":"analysisId","description":"ID of analysis result.","in":"path","required":true,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer"},"required":false},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer"},"required":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RollupPricingMetricsOutput"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/rollup-ep":{"get":{"tags":["Rollup Analyses"],"summary":"Search rollup EP metrics","description":" ","operationId":"getRollupEpMetricsByAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32","default":100,"maximum":1000}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property        |Type| Comparison                        | Logical|\n|:-------------- |:--------|:---------------------------------|\n|`positionName`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND`, `OR`|\n|`scenarioUuid`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND`, `OR`|\n|`positionType`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND`, `OR`|\n\nRollup analysis result queries support both `*` and `%` as wild card characters in comparison filters. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RollupEpMetricsOutput"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/analyses/{analysisId}/rollup-key-losses":{"get":{"tags":["Rollup Analyses"],"summary":"Search rollup key losses","description":" ","operationId":"getRollupKeyLossesByAnalysis","parameters":[{"name":"analysisId","in":"path","description":"ID of analysis result.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32","default":100,"maximum":1000}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property        |Data Type|Comparison                        |Logical|\n|:-------------- |:--------|:---------------------------------|:--------|\n|`positionName`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND` `OR`|\n|`scenarioUuid`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND` `OR`|\n|`positionType`  |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND` `OR`|\n|`epType`        |`String` |`=`, `!=`, `LIKE` (wild cards: `%`, `*`) | `AND` `OR`|\n|`returnPeriod`  |`Number` |`=`, `!=`                         | `AND` `OR`|\n\nRollup analysis result queries support both `*` and `%` as wild card characters in comparison filters. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RollupKeyLossesOutput"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/branches":{"get":{"tags":["Branches"],"summary":"Search branches","description":" ","operationId":"getBranches","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property |Data Type|Comparison|List|\n|:--------|:--------|:--------|:--------|\n|`branchId`|`Number`|`=`, `!=`, `>`, `<`, `>=`, `<=`  |`IN`, `NOT IN`|\n|`branchName`|`String`|`=`, `!=`, `LIKE`, `NOT LIKE`  |`IN`, `NOT IN`|\n\nUse the `AND` and `OR` logical operators to form compound queries. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#branches).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `branchId`, `branchName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Branch"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Branches"],"summary":"Create branch","description":" ","operationId":"createBranch","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new Branch","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/branches/{id}":{"get":{"tags":["Branches"],"summary":"Get branch","description":" ","operationId":"getBranchById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of branch.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Branches"],"summary":"Update branch","description":" ","operationId":"updateBranch","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of branch.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"required":true},"responses":{"204":{"description":"Branch is updated in the data source successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Branches"],"summary":"Delete branch","description":" ","operationId":"deleteBranch","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of branch.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Branch is deleted from the data source successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchysets":{"post":{"tags":["Business Hierarchy Sets"],"summary":"Create business hierarchy set","operationId":"createBusinessHierarchySet","parameters":[{"name":"x-rms-requestid","in":"header","required":false,"description":"If specified, this request is _idempotent_. See [Idempotent Requests](doc:idempotent-requests)","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessHierarchySet"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Resource Location","style":"simple","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Business Hierarchy Sets"],"summary":"Search business hierarchy sets","operationId":"searchBusinessHierarchySets","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchySet"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchysets/{businessHierarchySetId}":{"patch":{"tags":["Business Hierarchy Sets"],"summary":"Update business hierarchy set","operationId":"updateBusinessHierarchySet","parameters":[{"name":"businessHierarchySetId","in":"path","description":"ID of business hierarchy set","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchBusinessHierarchySetRequest"}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Business Hierarchy Sets"],"summary":"Get business hierarchy set","operationId":"GetBusinessHierarchySet","parameters":[{"name":"businessHierarchySetId","in":"path","description":"ID of business hierarch set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessHierarchySet"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Business Hierarchy Sets"],"summary":"Delete business hierarchy set","operationId":"DeleteBusinessHierarchySetById","parameters":[{"name":"businessHierarchySetId","in":"path","description":"ID business hierarchy set","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchysets/{businessHierarchysetId}/businessHierarchies":{"post":{"tags":["Business Hierarchies"],"summary":"Create Business Hierarchy","operationId":"createBusinessHierarchy","parameters":[{"name":"x-rms-requestid","in":"header","required":false,"description":"If specified, this request is _idempotent_. See [Idempotent Requests](doc:idempotent-requests)","schema":{"type":"string"}},{"name":"businessHierarchysetId","in":"path","required":true,"description":"ID of parent business hierarchy set","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessHierarchy"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Resource Location","style":"simple","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchies":{"get":{"tags":["Business Hierarchies"],"summary":"Search business hierarchies","operationId":"searchBusinessHierarchies","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}},{"name":"includeLatestOnly","in":"query","description":"If `true`, returns latest business hierarchy in set.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchySummary"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchies/{businessHierarchyId}":{"patch":{"tags":["Business Hierarchies"],"summary":"Update Business Hierarchy","operationId":"updateBusinessHierarchy","parameters":[{"name":"businessHierarchyId","in":"path","description":"ID of business hierarchy","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BusinessHierarchy"},{"type":"object","properties":{"primeAnalysisId":{"type":"integer","nullable":true}}}]}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Business Hierarchies"],"summary":"Get Business Hierarchy","operationId":"getBusinessHierarchy","parameters":[{"name":"businessHierarchyId","in":"path","description":"ID of business hierarchy","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessHierarchy"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Business Hierarchies"],"summary":"Delete Business Hierarchy","operationId":"deleteBusinessHierarchy","parameters":[{"name":"businessHierarchyId","in":"path","description":"ID of business hierarchy","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchyvariations":{"get":{"tags":["Business Hierarchy Variations"],"summary":"Search Business Hierarchy Variations","operationId":"searchBusinessHierarchyVariations","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}},{"name":"includeLatestOnly","in":"query","description":"If true, returns only 1 latest BH per BH Set","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchyVariationSummary"}}}}}}}},"/businesshierarchyvariations/{businessHierarchyVariationId}":{"get":{"tags":["Business Hierarchy Variations"],"summary":"Get Business Hierarchy Variation","operationId":"GetBusinessHierarchyVariation","parameters":[{"name":"businessHierarchyVariationId","in":"path","description":"ID of business hierarchy variation.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BusinessHierarchyVariation"}]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Business Hierarchy Variations"],"summary":"Delete Business Hierarchy Variation","operationId":"DeleteBusinessHierarchyvariation","parameters":[{"name":"businessHierarchyVariationId","in":"path","description":"ID of business hierarchy variation.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/cedants":{"get":{"tags":["Cedants"],"summary":"Search cedants","description":" ","operationId":"getCedants_1","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n|Property|Data Type|Comparison|List|\n|:--------|:--------|:--------|:--------|\n|`cedantId`|`String`|`=`, `!=`, `LIKE`, `NOT LIKE`  |`IN`, `NOT IN`|\n|`cedantName`|`String`|`=`, `!=`, `LIKE`, `NOT LIKE`  |`IN`, `NOT IN`|\n\nUse the `AND` and `OR` logical operators to form compound queries. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#cedants).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending)\n\nSupported properties: `cedantId`, `cedantName`. See [Response Pagination](doc:response-pagination)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Cedant"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Cedants"],"summary":"Create cedant","description":" ","operationId":"createCedant","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cedant"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new Cedant","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict. Resource already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/cedants/{id}":{"get":{"tags":["Cedants"],"summary":"Get cedant","description":" ","operationId":"getCedantById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of cedant.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cedant"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Cedants"],"summary":"Update cedant","description":" ","operationId":"updateCedant","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of cedant.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cedant"}}},"required":true},"responses":{"204":{"description":"Cedant is updated in the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Cedants"],"summary":"Delete cedant","description":" ","operationId":"deleteCedant","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of cedant.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Cedant is deleted from the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/dataservers":{"get":{"tags":["Database Servers"],"summary":"Search database servers","description":" ","operationId":"searchDbInstances","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to filter response data by property values. \n\n|Property|Type|Comparison|Logical|\n|:--------|:--------|-------|:--------|\n|`serverId`|`Number`|`=`|`AND`,`OR` |\n|`serverName`|`String`|`=`|`AND`,`OR` |\n|`serverType`|`String`|`=`|`AND`,`OR` |\n\nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataServer"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/dataservers/{serverId}/databases":{"get":{"tags":["Databases"],"summary":"Search databases","operationId":"getDatabases","parameters":[{"name":"serverId","description":"ID of a manager SQL Server instance on Data Bridge.","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `databaseId`, `databaseName`, `databaseType`, `databaseVersion`.  Operators depend on the data type of the property. \n\n|Property|Data Type|Comparison|List|\n|:--------|:--------|:--------|:--------|\n|`databaseId`|`Number`|`=`, `!=`  |`IN`, `NOT IN`|\n|`databaseName`|`String`|`=`, `!=`, `LIKE`, `NOT LIKE`  |`IN`, `NOT IN`|\n|`databaseType`|`String`|`=`, `!=`  |`IN`, `NOT IN`|\n|`databaseVersion`|`String`|`=`, `!=`, `LIKE`, `NOT LIKE`  |`IN`, `NOT IN`|\n\nUse the `AND` and `OR` logical operators to defined compound queries. See [Filtering Responses](doc:response-filtering#databases).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `databaseName`, `databaseType`, `databaseVersion` See [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"databaseName ASC"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataBridgeDatabase"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/dataservers/{serverId}/databases/{databaseId}/register":{"post":{"tags":["Databases"],"summary":"Register EDM","operationId":"registerDatabase","parameters":[{"name":"serverId","in":"path","description":"ID of managed SQL Server instance on Data Bridge.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"databaseId","in":"path","description":"ID on EDM database on the specified `serverId`.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IrpRegisterDatabridgeDatabaseInfo"}}},"required":true},"responses":{"202":{"description":"Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposuresets/{exposureSetId}/exposures":{"post":{"tags":["Exposures"],"summary":"Create EDM","operationId":"createExposures","parameters":[{"name":"exposureSetId","in":"path","description":"ID of exposure set.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exposure"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA `CREATE_EDM` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `CREATE_EDM` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}":{"get":{"tags":["Exposures"],"summary":"Get EDM","description":" ","operationId":"searchExposureById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exposure"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Exposures"],"summary":"Delete EDM","operationId":"deleteExposure","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `DELETE_EDM` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `DELETE_EDM` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/archive":{"post":{"tags":["Exposures"],"summary":"Archive EDM","description":" ","operationId":"archiveExposure","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Archive"}}}},"responses":{"202":{"description":"Accepted.\n\nAn `ARCHIVE_EDM` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `ARCHIVE_EDM` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/move":{"post":{"tags":["Exposures"],"summary":"Move EDM","description":" ","operationId":"moveExposure","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveExposureRequest"}}}},"responses":{"202":{"description":"Accepted.\n\nA `MOVE_DATABASE` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `MOVE_DATABASE` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/bulk-edit":{"post":{"tags":["Exposures"],"summary":"Exposure bulk edit","operationId":"exposureBulkEdit","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM (exposure data module).","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExposureBulkEdit"}}},"required":true},"responses":{"202":{"description":"Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/update-metrics":{"post":{"tags":["Exposures"],"operationId":"updateExposureMetrics","summary":"Refresh EDM metadata","description":"","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"202":{"description":"Accepted.\n\nA `UPDATE_METRICS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `UPDATE_METRICS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/unregister":{"post":{"tags":["Exposures"],"summary":"Deregister EDM","operationId":"deregisterDatabase","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"202":{"description":"Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures":{"get":{"tags":["Exposures"],"summary":"Search EDMs","description":" ","operationId":"searchExposures","parameters":[{"name":"x-include-total-count","description":"If `true`, response returns `x-total-count` header with the number of exposures (EDMs).","in":"header","schema":{"type":"boolean","default":false}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `exposureId`, `exposureName`, `ownerName`, `serverName`, `status`, `tagIds`. Operators depend on the data type of the property.\n\n| Property       | Data Type    | Comparison                      | List          |\n| :------------- | :--------    | :------------------------------ | :------------ |\n| `exposureId`   | `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN` `NOT IN` |\n| `exposureName` | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN` `NOT IN` |\n| `exposureSetId`| `Number`     | `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN` `NOT IN` |\n| `ownerName`    | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN` `NOT IN` |\n| `serverName`   | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN` `NOT IN` |\n| `status`       | `String`     | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN` `NOT IN` |\n| `tagIds`       | `Array`      | `=`, `!=`                       | `IN` `NOT IN` |\n| `createdBy`    | `String`     | `=`                             | `IN`          |\n| `updatedBy`    | `String`     |`=`                              | `IN`          |\n| `createdAt`    | `YYYY-MM-DD` | `=` `>` `<`                     |               |\n| `updatedAt`    | `YYYY-MM-DD` | `=` `>` `<`                     |               |\n\nUse the `AND` and `OR` logical operators to defined compound queries. See [Filtering Responses](doc:response-filtering#edms).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `createdBy`, `createdAt`, `exposureId`, `exposureName`, `ownerName`, `serverName`, `status`, `updatedBy`, `updatedAt`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string","default":"exposureName ASC"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","headers":{"x-total-count":{"description":"Total number of exposures (EDMs) returned. \n\nReturned only if the `x-include-total-count` header parameter is `true`.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Exposure"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/update-tags":{"post":{"tags":["Exposures"],"summary":"Update exposure tags","operationId":"updateExposureTags","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM (exposure data module).","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataTagEntity"}}},"required":true},"responses":{"204":{"description":"Data Tags for Exposure successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/data-upgrade":{"post":{"tags":["Exposures"],"summary":"Upgrade EDM data version","operationId":"upgradeExposure","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM (exposure data module).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeExposureRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nAlthough this operation returns `202 Accepted`, no job is created. This operation immediately upgrades the EDM data version. Allow one to two minutes before running geocode, hazard lookup, or model operations on exposure data.","headers":{"Location":{"description":"URI of job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposuresets":{"get":{"tags":["Exposure Sets"],"summary":"Search exposure sets","operationId":"searchExposureSets","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `exposureSetId`, `exposureSetName`, `guid`. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#exposure-sets).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `exposureSetId`, `exposureSetName`, `guid`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExposureSet"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Exposure Sets"],"summary":"Create exposure set","operationId":"createExposureSet","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExposureSet"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of exposure set resource, e.g. `https://host/platform/riskdata/v1/exposuresets/3137630`.","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposuresets/{exposureSetId}":{"get":{"tags":["Exposure Sets"],"summary":"Get exposure set","operationId":"getExposureSetById","parameters":[{"name":"exposureSetId","in":"path","description":"System-defined ID of exposure set.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExposureSet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Exposure Sets"],"summary":"Update exposure set","operationId":"updateExposureSet","parameters":[{"name":"exposureSetId","in":"path","description":"System-defined ID of exposure set.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"description":"Updates to this exposure set","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchExposureSetRequest"}}}}},"responses":{"204":{"description":"Updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposurevariations":{"get":{"tags":["Exposure Variations"],"summary":"Search exposure variations","operationId":"searchExposureVariations","parameters":[{"name":"x-include-total-count","description":"If `true`, response returns `x-total-count` header with the number of exposures (EDMs).","in":"header","schema":{"type":"boolean","default":false}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property|Comparison|Logical|\n|--------|----------|-------|\n|`accountsCount`| `=`|  `AND`|\n|`accumulationCompatible`| `=`|  `AND`|\n|`createdAt`| `=`|  `AND`|\n|`createdBy`| `=`|  `AND`|\n|`exposureName`| `=`|  `AND`|\n|`exposureResourceId`| `=`| `AND`|\n|`exposureResourceName`| `=`| `AND`|\n|`exposureResourceNumber`| `=`| `AND`|\n|`exposureResourceType`| `=`| `AND`|\n|`exposureVariationId`| `=`| `AND`|\n|`fileSizeInBytes`| `=`|  `AND`|\n|`locationsCount`| `=`|  `AND`|\n|`perils`| `=`| `AND`|\n|`variationName`| `=`| `AND`|\n|`version`| `=` |`AND`|\n\nSupported properties: `accumulationCompatible`, `exposureVariationId`, `exposureVariationName`, `exposureResourceType`, `exposureResourceName`, `exposureName`\n\nOperators depend on the data type of the property. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `exposureSetId` `exposureSetName` `guid` `exposureVariationId`, `exposureVariationName`, `exposureResourceType`, `exposureResourceName`, `exposureName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","headers":{"x-total-count":{"description":"Total number of exposure variations returned. \n\nReturned only if the `x-include-total-count` header parameter is `true`.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExposureVariation"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposurevariations/{exposureVariationId}":{"get":{"tags":["Exposure Variations"],"summary":"Get exposure variation","operationId":"getExposureVariationById","parameters":[{"name":"exposureVariationId","in":"path","description":"ID of exposure variation.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExposureVariation"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/faclayers":{"get":{"tags":["Utilities"],"summary":"Search facultative reinsurers","operationId":"getFacultatives","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `facultativeId` `facultativeName`. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#facultatives).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `facultativeId`, `facultativeName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Facultative"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Utilities"],"summary":"Create facultative reinsurer","operationId":"createFacultative","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Facultative"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new Facultative","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict. Resource already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/faclayers/{id}":{"get":{"tags":["Utilities"],"summary":"Get facultative reinsurer","operationId":"getFacultativeById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of facultative reinsurer.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Facultative"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Utilities"],"summary":"Update facultative reinsurer","operationId":"updateFacultative","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of facultative reinsurer.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Facultative"}}},"required":true},"responses":{"204":{"description":"Facultative reinsurer is updated in the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Utilities"],"summary":"Delete facultative reinsurer","operationId":"deleteFacultative","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of facultative reinsurer.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Facultative reinsurer is deleted from the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/globaledit/dryrun":{"post":{"tags":["Utilities"],"summary":"Update exposures dry run","operationId":"dryRun","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEdit"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/globaledit":{"post":{"tags":["Utilities"],"summary":"Update exposures","operationId":"edit","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEdit"}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/jobs/{jobId}":{"get":{"tags":["Risk Data Jobs"],"summary":"Get risk data job","description":"Returns information about a risk data job. For `MOVE_DATABASE` jobs, `details.log` includes `sourceServerName`, `destinationServerName`, `databaseType`, `databaseName`, and `edmName`.","operationId":"getRiskDataJobById","parameters":[{"name":"jobId","in":"path","description":"ID of job.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDetailResponse"}}}},"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Risk Data Jobs"],"summary":"Update risk data job","description":" ","operationId":"updateRiskDataJob","parameters":[{"name":"jobId","in":"path","description":"ID of job.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchJobRequest"}}},"required":true},"responses":{"202":{"description":"Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/jobs":{"get":{"tags":["Risk Data Jobs"],"summary":"Search risk data jobs","description":"Returns a list of risk data jobs. Supports filtering by `type` including `MOVE_DATABASE`.","operationId":"getRiskDataJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property|Comparison|Logical|\n|--------|----------|-------|\n|`jobId`| `=`|  `AND`|\n|`type`| `=`| `AND`|\n|`name`| `=`| `AND`|\n|`userName`| `=`| `AND`|\n|`status`| `=` |`AND`|\n|`startedAt`| `=`| `AND`|\n|`endedAt`| `=`| `AND`|\n\nOperators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#risk-data-jobs).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Response is sorted by each <<glossary:property>>. Sort order defined by one of`ASC` or `DESC`.\nSupported properties: `jobId`, `name`, `status`, `type`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/lobs":{"get":{"tags":["Line of Business"],"summary":"Search lines of business","description":" ","operationId":"getLinesOfBusiness","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n|Property|Type|Comparison|List|Logical|\n|--------|----|----------|----|-------|\n|`lobId`|Number|`=`, `!=`, `<=`, `>=`, `>`, `<`|`IN`, `NOT IN`|`AND`, `OR`\n| `lobName`| String| `=`, `!=`, `LIKE`, `NOT LIKE` |`IN`, `NOT IN`|`AND`, `OR`\n\nSupported operators depend on property data type. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties:`lobId`, `lobName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LineOfBusiness"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Line of Business"],"summary":"Create line of business","description":" ","operationId":"createLineOfBusiness","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineOfBusiness"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new LineOfBusiness","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/lobs/{id}":{"get":{"tags":["Line of Business"],"summary":"Get line of business","description":" ","operationId":"getLineOfBusinessById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of line of business.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineOfBusiness"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Line of Business"],"summary":"Update line of business","description":" ","operationId":"updateLineOfBusiness","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of line of business.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineOfBusiness"}}},"required":true},"responses":{"204":{"description":"LineOfBusiness is updated in the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Line of Business"],"summary":"Delete line of business","description":" ","operationId":"deleteLineOfBusiness","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of line of business.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"LineOfBusiness is deleted from the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations":{"get":{"tags":["Locations"],"summary":"Search locations","description":" ","operationId":"searchLocations","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported filters: `accountId`, `addressType`, `admin1Code`, `admin1Name`, `admin2Code`, `admin2Name`, `admin3Code`, `admin3Name`, `admin4Code`, `admin4Name`, `area`, `areaUnit`, `bldgHeight`, `bldgValuation`, `block`, `blockGroup`, `buildingClass`, `buildingClassScheme`, `buildingId`, `buildingName`, `buildings`, `cityCode`, `cityName`, `contentLossTrigger`, `country`, `countryRmsCode`, `countryScheme`, `currency`, `dwellTime`, `expireDate`, `floodDefHtAboveGrnd`, `floodDefenseElevation`, `floodDefenseElevationUnit`, `floorArea`, `floorOccupancy`, `geoResolutionCode`, `heightUnit`, `heightUnit`, `huZone`, `inceptDate`, `isPrimaryBldg`, `latitude`, `locationCode`, `locationId`, `locationName`, `locationNumber`, `longitude`, `mfdSubcategory`, `nship`, `occupancyType`, `occupancyTypeScheme`, `otherZone`, `postalCode`, `propertyReference`, `rentalPropertyIdentifier`, `siteName`, `slope`, `stories`, `streetAddress`, `tiv`, `updateDate`, `useContentValue`, `userBfe`, `userGroundElev`, `userId1`, `userId2`, `userText1`, `userText2`, `yearBuilt`, `zone1`, `zone3Name`, `zone4Name`\n\nOperators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#locations).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `accountId`, `addressType`, `admin1Code`, `admin1Name`, `admin2Code`, `admin2Name`, `admin3Code`, `admin3Name`, `admin4Code`, `admin4Name`, `area`, `areaUnit`, `bldgHeight`, `bldgValuation`, `block`, `blockGroup`, `buildingClass`, `buildingClassScheme`, `buildingId`, `buildingName`, `buildings`, `cityCode`, `cityName`, `contentLossTrigger`, `countryRmsCode`, `countryScheme`, `currency`, `dwellTime`, `expireDate`, `floodDefHtAboveGrnd`, `floodDefenseElevation`, `floodDefenseElevationUnit`, `floorArea`, `floorOccupancy`, `geoResolutionCode`, `heightUnit`, `huZone`, `inceptDate`, `isPrimaryBldg`, `latitude`, `locationCode`, `locationId`, `locationName`, `locationNumber`, `longitude`, `mfdSubcategory`, `nship`, `occupancyType`, `occupancyTypeScheme`, `otherZone`, `postalCode`, `propertyReference`, `rentalPropertyIdentifier`, `siteName`, `slope`, `stories`, `streetAddress`, `tiv`, `updateDate`, `useContentValue`, `userBfe`, `userGroundElev`, `userId1`, `userId2`, `userText1`, `userText2`, `yearBuilt`, `zone1`, `zone3Name`, `zone4Name`. \n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationSearchItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Locations"],"summary":"Create location","operationId":"createLocation","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"URL for the new location","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}":{"get":{"tags":["Locations"],"summary":"Get location","operationId":"getLocationById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update location","operationId":"updateLocation","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}},"required":true},"responses":{"204":{"description":"Location updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete location","operationId":"deleteLocation","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/buildingattribute":{"post":{"tags":["Locations"],"summary":"Create building attribute","operationId":"createBuildingAttribute","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingAttribute"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new building attribute","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/buildingattribute/{buildingattributeid}":{"get":{"tags":["Locations"],"summary":"Get building attribute","operationId":"getBuildingAttribute","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"buildingattributeid","in":"path","description":"ID of building attribute.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingAttribute"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update building attribute","operationId":"updateBuildingAttribute","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"buildingattributeid","in":"path","description":"location of location building attribute.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingAttribute"}}},"required":true},"responses":{"204":{"description":"Building attribute updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete building attribute","operationId":"deleteBuildingAttribute","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"buildingattributeid","in":"path","description":"ID of location building attribute.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Building attribute successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/geocode":{"post":{"tags":["Locations"],"summary":"Geocode location","description":" ","operationId":"geoCodeByLocationId","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LayerInfo"}}}},"required":true},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/enricheddetails":{"get":{"tags":["Locations"],"summary":"Get location enrichment details","description":" ","operationId":"getEnrichedDetails","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":" Information for specified enriched details is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichedDetails"}}}},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationconditions":{"post":{"tags":["Locations"],"summary":"Create location condition","operationId":"createLocationCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCondition"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new location condition","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationconditions/{conditionid}":{"get":{"tags":["Locations"],"summary":"Get location condition","description":" ","operationId":"getLocationConditionById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of location condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Location condition successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationCondition"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update location condition","description":" ","operationId":"updateLocationCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of location condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCondition"}}},"required":true},"responses":{"204":{"description":"Location condition successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaLinks"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete location condition","description":" ","operationId":"deleteLocationCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID location condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location condition successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/policyconditions":{"get":{"tags":["Locations"],"summary":"Search policy conditions by location","description":" ","operationId":"getPolicyConditions","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":" Policy conditions successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationPolicyCondition"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationcoverages":{"post":{"tags":["Locations"],"summary":"Create location coverage","operationId":"createLocationCoverage","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCoverage"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new coverage","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationcoverages/{coverageid}":{"get":{"tags":["Locations"],"summary":"Get location coverage","description":" ","operationId":"getLocationCoverage","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID of location coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCoverage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update location coverage","description":" ","operationId":"updateLocationCoverage","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID of location coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCoverage"}}},"required":true},"responses":{"204":{"description":"Coverage successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaLinks"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete location coverage","description":" ","operationId":"deleteLocationCoverage","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID oflocation coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location coverage successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationcessions":{"post":{"tags":["Locations"],"summary":"Create location cession","operationId":"createLocationReinsuranceCession","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location. Location cession is applied to this location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCession"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"URL of new location cession.","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationcessions/{cessionid}":{"get":{"tags":["Locations"],"summary":"Get location cession","description":" ","operationId":"getLocationReinsuranceCessionDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of location cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"ReinsuranceCession details successfully returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCessionDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update location cession","description":" ","operationId":"updateLocationReinsuranceCession","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of location cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCession"}}},"required":true},"responses":{"204":{"description":"Location cession successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete location cession","description":" ","operationId":"deleteLocationReinsuranceCession","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of the location cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location reinsurance cession successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationbidetail":{"post":{"tags":["Locations"],"summary":"Create BI peril","description":" ","operationId":"createLocationBiDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationBiDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new bi detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationbidetail/{locationbidetailid}":{"get":{"tags":["Locations"],"summary":"Get BI peril","operationId":"getLocationBiDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationbidetailid","in":"path","description":"ID of BI peril.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns location bi detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationBiDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update BI peril","description":" ","operationId":"updateLocationBiDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationbidetailid","in":"path","description":"ID of BI peril.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationBiDetail"}}},"required":true},"responses":{"204":{"description":"Bi detail successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaLinks"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete BI peril","description":" ","operationId":"deleteLocationBiDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationbidetailid","in":"path","description":"ID of BI peril.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Bi detail successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationeqdetail":{"post":{"tags":["Locations"],"summary":"Create EQ peril","operationId":"createLocationEqDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationEqDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new EQ detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationeqdetail/{locationeqdetailid}":{"get":{"tags":["Locations"],"summary":"Get EQ peril","description":" ","operationId":"getLocationEqDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationeqdetailid","in":"path","description":"ID of location earthquake record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"EQ detail successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationEqDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update EQ peril","description":" ","operationId":"updateLocationEqDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationeqdetailid","in":"path","description":"ID of the location earthquake record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationEqDetail"}}},"required":true},"responses":{"204":{"description":"EQ Detail Successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaLinks"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete EQ peril","description":" ","operationId":"deleteLocationEqDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationeqdetailid","in":"path","description":"ID of location earthquake record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"EQ detail successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationfldetail":{"post":{"tags":["Locations"],"summary":"Create FL peril","operationId":"createLocationFlDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFlDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new FL detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationfldetail/{locationfldetailid}":{"get":{"tags":["Locations"],"summary":"Get FL peril","description":" ","operationId":"getLocationFlDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfldetailid","in":"path","description":"ID of the location flood record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"FL detail successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFlDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update FL peril","description":" ","operationId":"updateLocationFlDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfldetailid","in":"path","description":"ID of the location flood record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFlDetail"}}},"required":true},"responses":{"204":{"description":"FL detail successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found."}}},"delete":{"tags":["Locations"],"summary":"Delete FL peril","description":" ","operationId":"deleteLocationFlDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfldetailid","in":"path","description":"ID of the location flood record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"FL detail successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationfrdetail":{"post":{"tags":["Locations"],"summary":"Create FR peril","operationId":"createLocationFrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFrDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of new FR detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationfrdetail/{locationfrdetailid}":{"get":{"tags":["Locations"],"summary":"Get FR peril","description":" ","operationId":"getLocationFrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfrdetailid","in":"path","description":"ID of the location fire record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"FR detail successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFrDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update FR detail","description":" ","operationId":"updateLocationFrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfrdetailid","in":"path","description":"ID of the location fire record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationFrDetail"}}},"required":true},"responses":{"204":{"description":"FR detail successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete FR peril","description":" ","operationId":"deleteLocationFrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationfrdetailid","in":"path","description":"ID of location fire record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"FR detail successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationtodetail":{"post":{"tags":["Locations"],"summary":"Create TO peril","operationId":"createLocationToDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationToDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new TO detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationtodetail/{locationtodetailid}":{"get":{"tags":["Locations"],"summary":"Get TO peril","description":" ","operationId":"getLocationToDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtodetailid","in":"path","description":"ID of location tornado record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"TO detail successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationToDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update TO peril","description":" ","operationId":"updateLocationToDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtodetailid","in":"path","description":"ID of location tornado record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationToDetail"}}},"required":true},"responses":{"204":{"description":"TO detail successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaLinks"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete TO peril","description":" ","operationId":"deleteLocationToDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtodetailid","in":"path","description":"ID of location tornado record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"TO detail successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationtrdetail":{"post":{"tags":["Locations"],"summary":"Create TR peril","operationId":"createLocationTrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationTrDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of Location TR Details","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationtrdetail/{locationtrdetailid}":{"get":{"tags":["Locations"],"summary":"Get TR peril","description":" ","operationId":"getLocationTrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtrdetailid","in":"path","description":"ID of location terrorism record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Location TR detail successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationTrDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update TR peril","description":" ","operationId":"updateLocationTrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtrdetailid","in":"path","description":"ID of location terrorism record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationTrDetail"}}},"required":true},"responses":{"204":{"description":"Location TR detail successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete TR peril","description":" ","operationId":"deleteLocationTrDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationtrdetailid","in":"path","description":"ID of location terrorism record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location TR detail successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationwcdetail":{"post":{"tags":["Locations"],"summary":"Create WC peril","operationId":"createLocationWcDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWcDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of Location WC Detail","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationwsdetail":{"post":{"tags":["Locations"],"summary":"Create WS peril","operationId":"createLocationWsDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWsDetail"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of Location WS Details","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationwcdetail/{locationwcdetailid}":{"get":{"tags":["Locations"],"summary":"Get WC peril","description":" ","operationId":"getLocationWcDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwcdetailid","in":"path","description":"ID of location worker compensation record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Location WC detail successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWcDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update WC peril","description":" ","operationId":"updateLocationWcDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwcdetailid","in":"path","description":"ID of location worker compensation record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWcDetail"}}},"required":true},"responses":{"204":{"description":"Location WC details successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete WC peril","description":" ","operationId":"deleteLocationWcDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwcdetailid","in":"path","description":"ID of location worker compensation record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location WC detail successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/locations/{id}/locationwsdetail/{locationwsdetailid}":{"get":{"tags":["Locations"],"summary":"Get WS peril","description":" ","operationId":"getLocationWsDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwsdetailid","in":"path","description":"ID of location windstorm record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Location WS Detail successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWsDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Locations"],"summary":"Update WS peril","description":" ","operationId":"updateLocationWsDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwsdetailid","in":"path","description":"ID of location windstorm record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationWsDetail"}}},"required":true},"responses":{"204":{"description":"Location WS Detail successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Locations"],"summary":"Delete WS peril","description":" ","operationId":"deleteLocationWsDetail","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of location.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"locationwsdetailid","in":"path","description":"ID of location windstorm record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Location WS Detail successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policyconditions":{"get":{"tags":["Policy Conditions"],"summary":"Search policy conditions","description":" ","operationId":"getAllPolicyConditions","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyCondition"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policyconditions/{conditionid}":{"get":{"tags":["Policy Conditions"],"summary":"Get policy condition","operationId":"getPolicyCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCondition"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies":{"get":{"tags":["Policies"],"summary":"Search policies","description":" ","operationId":"searchPolicies","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property                  | Comparison                 | List          | \n| ------------------------- | -------------------------- | ------------- | \n| `policyId`                | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `policyNumber`            | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `accountId`               | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `peril`                   | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `status`                  | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `currency`                | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `inceptionDate`           | `=` `!=` `<=` `>=` `>` `<` |               | \n| `expirationDate`          | `=` `!=` `<=` `>=` `>` `<` |               | \n| `attachmentPoint`         | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `minDeductible`           | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `maxDeductible`           | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `blanketLimit`            | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `blanketDeductible`       | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `structure`               | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `blanketPremium`          | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `coverageBase`            | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `limitGU`                 | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `partOf`                  | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `userText1`               | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `userText2`               | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `userText3`               | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `userText4`               | `=` `!=` `LIKE` `NOT LIKE` | `NOT IN` `IN` | \n| `newCauseOfLoss`          | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `percentOfLossDeductible` | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `aggregateMinDeductible`  | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `aggregateMaxDeductible`  | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `aggregateLimit`          | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n| `isFranchiseDeductible`   | `=` `!=` `<=` `>=` `>` `<` | `NOT IN` `IN` | \n\nUse logical operators (`AND`, `OR`) to defined compound queries. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `accountId`, `aggregateLimit`, `aggregateMaxDeductible`, `aggregateMinDeductible`, `attachmentPoint`, `attachmentPoint`, `blanketDeductible`, `blanketLimit`, `blanketPremium`, `coverageBase`, `currency`, `expirationDate`, `inceptionDate`, `isFranchiseDeductible`, `limitGU`, `lobId`, `maxDeductible`, `minDeductible`, `newCauseOfLoss`, `partOf`, `percentOfLossDeductible`, `peril`, `policyId`, `policyNumber`, `status`, `structure`, `userText1`, `userText2`, `userText3`, `userText4`\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"List of policies is successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Policy"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Policies"],"summary":"Create policy","description":" ","operationId":"createPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new policy","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}":{"get":{"tags":["Policies"],"summary":"Get policy","description":" ","operationId":"getPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Information on a specified policy is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Policies"],"summary":"Update policy","description":" ","operationId":"updatePolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"required":true},"responses":{"204":{"description":"Policy successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Policies"],"summary":"Delete policy","description":" ","operationId":"deletePolicy","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Policy successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/policyconditions":{"post":{"tags":["Policies"],"summary":"Create policy condition","description":" ","operationId":"createPolicyCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCondition"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"location of the new policy condition","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/policyconditions/{conditionid}":{"get":{"tags":["Policies"],"summary":"Get policy condition","operationId":"getPolicyCondition_1","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCondition"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Policies"],"summary":"Update policy condition","description":" ","operationId":"updatePolicyCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCondition"}}},"required":true},"responses":{"204":{"description":"Policy condition successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Policies"],"summary":"Delete policy condition","description":" ","operationId":"deletePolicyCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Policy condition successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/policyconditions/{conditionid}/backfill":{"post":{"tags":["Policies"],"summary":"Back fill policy condition","operationId":"backFillPolicyCondition","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"202":{"description":"Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{policyId}/policyconditions/{conditionId}/criteria/bulk-replace":{"post":{"tags":["Policies"],"summary":"Bulk replace policy condition criteria","description":" ","operationId":"bulkReplace","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"policyId","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionId","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/":{"schema":{"$ref":"#/components/schemas/ComplexPolicyConditionCriteria"}}}},"responses":{"201":{"description":"Created.","content":{"application/":{"schema":{"$ref":"#/components/schemas/PolicyConditionCriterias"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/coverages":{"post":{"tags":["Policies"],"summary":"Create policy coverage","description":" ","operationId":"createPolicyCoverage","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCoverage"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new policy coverage","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/coverages/{coverageid}":{"get":{"tags":["Policies"],"summary":"Get policy coverage","description":" ","operationId":"getPolicyCoverage","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID of policy coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Information on a specified poliy coverage is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCoverage"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Policies"],"summary":"Update policy coverage","description":" ","operationId":"updatePolicyCoverage","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID of policy coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCoverage"}}},"required":true},"responses":{"204":{"description":"Policy coverage successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Policies"],"summary":"Delete policy coverage","description":" ","operationId":"deletePolicyCoverage","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"coverageid","in":"path","description":"ID of policy coverage.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Policy coverage successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/cessions":{"post":{"tags":["Policies"],"summary":"Create policy cession","description":" ","operationId":"createPolicyReinsuranceCession","parameters":[{"name":"id","in":"path","description":"ID of policy. Policy cession is applied to this policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCession"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new policy cession.","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/cessions/{cessionid}":{"get":{"tags":["Policies"],"summary":"Get policy cession","description":" ","operationId":"getPolicyReinsuranceCession","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of policy cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Policy cession retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCessionDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Policies"],"summary":"Update policy cession","description":" ","operationId":"updatePolicyReinsuranceCession","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of policy cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReinsuranceCession"}}},"required":true},"responses":{"204":{"description":"Policy cession successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Policies"],"summary":"Delete policy cession","description":" ","operationId":"deletePolicyReinsuranceCession","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"cessionid","in":"path","description":"ID of policy cession.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Policy cession successfully deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/policyconditions/{conditionid}/locationconditions":{"get":{"tags":["Policies"],"summary":"Get location conditions","description":" ","operationId":"getLocationConditions","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of policy","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"conditionid","in":"path","description":"ID of policy condition.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LocationCondition"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/policies/{id}/surplustreaties":{"get":{"tags":["Policies"],"summary":"Get surplus treaties by policy","description":" ","operationId":"getSurplusTreaties","parameters":[{"name":"id","in":"path","description":"ID of policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of surplus treaties for a specified policy is successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Treaty"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios":{"get":{"tags":["Portfolios"],"summary":"Search portfolios","description":" ","operationId":"searchPortfolios","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                  | Comparison                 | List          | \n| ------------------------- | -------------------------- | ------------- | \n|`portfolioId`|`=` `!=` `>` `<` `>=` `<=`| `IN` `NOT IN` |\n|`portfolioNumber`|`=`, `!=` `LIKE`  `NOT LIKE`| `IN` `NOT IN`|\n|`portfolioName`|`=` `!=` `LIKE`  `NOT LIKE` |`IN` `NOT IN`|\n|`description`|`=` `!=` `LIKE`  `NOT LIKE` |`IN` `NOT IN`|\n|`ownerName`|`=` `!=` `LIKE`  `NOT LIKE` |`IN` `NOT IN`|\n|`createDate`|`=` `!=` `>` `<` `>=` `<=`| `IN` `NOT IN` |\n|`stampDate`|`=` `!=` `>` `<` `>=` `<=`| `IN` `NOT IN` |\n\nThis parameter also supports logical operators (`AND`, `OR`) for defining compound expressions. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `createDate`, `description`, `portfolioId`, `portfolioName`, `portfolioNumber`, `stampDate`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"List of portfolios retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PortfolioSearch"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Portfolios"],"summary":"Create portfolio","description":" ","operationId":"createPortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Portfolio resource","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios/{id}":{"get":{"tags":["Portfolios"],"summary":"Get portfolio","description":" ","operationId":"getPortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Portfolio information retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Portfolios"],"summary":"Delete portfolio","description":" ","operationId":"deletePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"deleteType","in":"query","description":"Scope of portfolio data to delete. One of `PORTFOLIO_INFO`, `PORTFOLIO_ALL_ACCOUNTS`, `PORTFOLIO_EXCEPT_ACCOUNTS`.","required":true,"schema":{"type":"string","enum":["PORTFOLIO_INFO","PORTFOLIO_ALL_ACCOUNTS","PORTFOLIO_EXCEPT_ACCOUNTS"]}},{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management)\n","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"responses":{"202":{"description":"Accepted.\n\nA `DELETE_PORTFOLIO` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `DELETE_PORTFOLIO` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Portfolios"],"summary":"Update portfolio","description":" ","operationId":"updatePortfolio","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of the portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Portfolio"}}},"required":true},"responses":{"204":{"description":"Portfolio successfully updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios/{id}/metrics":{"get":{"tags":["Portfolios"],"summary":"Get portfolio metadata","description":" ","operationId":"getPortfolioMetrics","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Metrics for a specified portfolio are successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioMetrics"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios/{id}/update-metrics":{"post":{"tags":["Portfolios"],"operationId":"updatePortfolioMetrics","summary":"Refresh portfolio metadata","description":"","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"202":{"description":"Accepted.\n\nA `UPDATE_METRICS` job has been added to the job queue for processing.","headers":{"Location":{"description":"URI of `UPDATE_METRICS` job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios/{id}/filtered-accounts":{"put":{"tags":["Portfolios"],"summary":"Manage filtered accounts by portfolio","description":" ","operationId":"manageFilteredAccounts","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of the portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PortfolioFilteredAccountsInput"}}},"required":true},"responses":{"200":{"description":"Portfolio accounts with filter updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/portfolios/{id}/accounts":{"get":{"summary":"Search accounts by portfolio","tags":["Accounts"],"operationId":"getPortfolioAccounts","parameters":[{"name":"exposureId","in":"path","required":true,"description":"ID of exposure (EDM).","schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"description":"ID of portfolio.","schema":{"type":"integer"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n|Property|Type|Comparison|List|\n|--------|----|----------|----|\n|`accountid`|`Number`| `=`, `!=`, `>`, `<`, `>=`, `<=` | `IN`, `NOT IN` |\n|`accountName`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`accountNumber`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`branchName`|`Number`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`cedantName`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`ownerName`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`producerName`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n|`underwriterName`|`String`| `=`, `!=`, `LIKE`, `NOT LIKE`| `IN`, `NOT IN` |\n\nCompound query filters can be defined using the `AND` and `OR` logical operators. See [Filtering Responses](doc:response-filtering.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `accountId`, `accountName`, `accountNumber`, `branchName`, `cedantName`, `ownerName`, `producerName`, `underwriterName`. \n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Portfolios"],"summary":"Manage accounts by portfolio","description":" ","operationId":"managePortfolioAccounts","parameters":[{"name":"id","in":"path","description":"ID of portfolio.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioAccountsInput"}}},"required":true},"responses":{"200":{"description":"Portfolio account updated."},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the \"Edit Portfolios\" action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/producers":{"get":{"tags":["Producers"],"summary":"Search producers","description":" ","operationId":"getProducers","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `producerId`, `producerName`. Operators depend on the data type of the property. See [Filtering Responses](doc:response-filtering#producers).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `producerId`, `producerName`. See [Response Pagination](doc:response-pagination)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Producer"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Producers"],"summary":"Create producer","description":" ","operationId":"createProducer","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Producer"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"location of the new Producer ","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict. Resource already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/producers/{id}":{"get":{"tags":["Producers"],"summary":"Get producer","description":" ","operationId":"getProducerById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of producer.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Producer"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Producers"],"summary":"Update producer","description":" ","operationId":"updateProducer","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of producer.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Producer"}}},"required":true},"responses":{"204":{"description":"Producer is updated in the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Producers"],"summary":"Delete producer","description":" ","operationId":"deleteProducer","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of producer.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Producer is deleted from the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programsets":{"post":{"tags":["Program Sets"],"summary":"Create program set","operationId":"createProgramSet","parameters":[{"name":"x-rms-requestid","in":"header","required":false,"description":"If specified, this request is _idempotent_. See [Idempotent Requests](doc:idempotent-requests)","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSet"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Resource Location","style":"simple","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Program Sets"],"summary":"Search program sets","operationId":"searchProgramSets","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProgramSet"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programsets/{programSetId}":{"patch":{"tags":["Program Sets"],"summary":"Update program set","operationId":"updateProgramSet","parameters":[{"name":"programSetId","in":"path","description":"ID of program set","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchProgramSetRequest"}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Program Sets"],"summary":"Get program set","operationId":"GetProgramSet","parameters":[{"name":"programSetId","in":"path","description":"ID of program set","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramSet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Program Sets"],"summary":"Delete program set","operationId":"DeleteProgramSet","parameters":[{"name":"programSetId","in":"path","description":"ID of program set","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programsets/{programSetId}/programs":{"post":{"tags":["Programs"],"summary":"Create inward program","operationId":"createProgram","parameters":[{"name":"x-rms-requestid","in":"header","required":false,"description":"If specified, this request is _idempotent_. See [Idempotent Requests](doc:idempotent-requests)","schema":{"type":"string"}},{"name":"programSetId","in":"path","required":true,"description":"ID of parent program set","schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramBase"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Resource Location","style":"simple","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/businesshierarchysets/{businessHierarchySetId}/programs":{"post":{"tags":["Programs"],"summary":"Create outward program","operationId":"createOutwardProgram","parameters":[{"name":"x-rms-requestid","in":"header","required":false,"description":"If specified, this request is _idempotent_. See [Idempotent Requests](doc:idempotent-requests)","schema":{"type":"string"}},{"name":"businessHierarchySetId","in":"path","required":true,"description":"ID of business hierarchy set that secures this program.","schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramBase"}}}},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Resource Location","style":"simple","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programs":{"get":{"tags":["Programs"],"summary":"Search programs","operationId":"searchPrograms","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProgramSummary"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programs/{programId}":{"patch":{"tags":["Programs"],"summary":"Update program","operationId":"updateProgram","parameters":[{"name":"programId","in":"path","description":"ID of program to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Program"}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Programs"],"summary":"Get program","operationId":"GetProgram","parameters":[{"name":"programId","in":"path","description":"ID of this program","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Program"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Programs"],"summary":"Delete program","operationId":"deleteProgram","parameters":[{"name":"programId","in":"path","description":"ID of program to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programs/{programId}/pricingformulae-defaults":{"get":{"summary":"Get default pricing formulae by program","operationId":"getProgramPricingFormulaDefaults","tags":["Programs"],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"corporateFormulaUuid":{"type":"string"},"technicalFormulaUuid":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the Download Report action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programvariations":{"get":{"tags":["Program Variations"],"summary":"Search program variations","operationId":"searchProgramVariations","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","schema":{"type":"string"}},{"name":"sort","in":"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.)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","maximum":100,"default":100}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProgramVariationSummary"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the Download Report action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/programvariations/{programVariationId}":{"get":{"tags":["Program Variations"],"summary":"Get progam variation","operationId":"GetProgramVariation","parameters":[{"name":"programVariationId","in":"path","description":"ID of program variation.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProgramVariation"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Program Variations"],"summary":"Delete progam variation","operationId":"DeleteProgramVariation","parameters":[{"name":"programVariationId","in":"path","description":"ID of program variation.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/reports":{"post":{"tags":["Reports"],"summary":"Create risk data report","operationId":"createRiskDataReport","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SummaryReportRequest"},{"$ref":"#/components/schemas/ExposureDoiReportRequest"},{"$ref":"#/components/schemas/PortfolioAccumulationDetailsRequest"},{"$ref":"#/components/schemas/BusinessHierarchyAccumulationDetailsRequest"},{"$ref":"#/components/schemas/AccountAccumulationDetailsRequest"}],"discriminator":{"propertyName":"reportType","mapping":{"EXPOSURE_SUMMARY":"#/components/schemas/SummaryReportRequest","ANALYSIS_SUMMARY":"#/components/schemas/SummaryReportRequest","EXPOSURE_DOI_REPORT":"#/components/schemas/ExposureDoiReportRequest","PORTFOLIO_ACCUMULATION_DETAILS":"#/components/schemas/PortfolioAccumulationDetailsRequest","BUSINESS_HEIRARCHY_ACCUMULATION_DETAILS":"#/components/schemas/BusinessHierarchyAccumulationDetailsRequest","ACCOUNT_ACCUMULATION_DETAILS":"#/components/schemas/AccountAccumulationDetailsRequest"}}}}},"required":true},"responses":{"202":{"description":"Accepted.\n\nA job has been added to the queue for processing.","headers":{"Location":{"description":"URI of job, e.g. `https://{host}/platform/riskdata/v1/jobs/{jobId}`. Use this endpoint to <<glossary:poll>> the status of the job. See [Get Risk Data Job](ref:getriskdatajobbyid).","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource is denied or not authorized to perform the Download Report action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/reportviews":{"get":{"tags":["Report Views"],"summary":"Search report views","operationId":"searchReportViews","parameters":[{"name":"exposureId","in":"query","description":"ID of exposure (EDM).","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                 | Comparison                 | List          |\n| ------------------------ | -------------------------- | ------------- |\n| `reportViewId`           | `=` `!=` `>` `<` `>=` `<=` | `IN` `NOT IN` |\n| `reportViewName`         | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` |\n| `createdAt`              | `=` `!=` `>` `<` `>=` `<=` |               |\n| `createdBy`              | `=` `!=` `LIKE` `NOT LIKE` | `IN` `NOT IN` |\n| `exposureResourceId`     | `=` `!=` `>` `<` `>=` `<=` | `IN` `NOT IN` |\n| `exposureResourceTypeId` | `=` `!=` `>` `<` `>=` `<=` | `IN` `NOT IN` |\n| `metricTypes`            | `=`                        | `IN`          |\n\n  This parameter also supports logical operators (`AND`, `OR`) for defining compound expressions. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `createdAt`, `createdBy`, `exposureResourceId`, `exposureResourceTypeId`, `reportViewId`, `reportViewName`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK\n\nList of report views successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportViewSummary"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/reportviews/{id}":{"delete":{"tags":["Report Views"],"summary":"Delete report view","description":" ","operationId":"deleteReportView","parameters":[{"name":"id","in":"path","description":"ID of the report view.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Report view successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"get":{"tags":["Report Views"],"summary":"Get report view","operationId":"getReportView","parameters":[{"name":"id","in":"path","description":"ID of report view.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK\n\nReport View retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportView"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/reportviews/{id}/analyses":{"get":{"tags":["Report Views"],"summary":"Get analyses by report view","operationId":"getReportViewAnalyses","parameters":[{"name":"id","in":"path","description":"ID of report view.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"x-rms-resource-group-id","description":"ID of UndewriteIQ  <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-management).","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                 | Comparison        | List  |\n| ------------------------ | ----------------- | ----- |\n| `analysisId`             | `=` `!=`          | `IN`  |\n| `appAnalysisId`          | `=` `!=`          | `IN`  |\n\nThe `analysisId` property is only supported for report views generated after March, 2025.\n\nThis parameter supports logical operators (`AND`, `OR`) for defining compound expressions. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}}],"responses":{"200":{"description":"OK\n\nReport View Details successfully retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportViewAnalysis"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/risksources/bulk-create":{"post":{"tags":["Risk Sources"],"summary":"Bulk create risk sources","operationId":"bulkCreateRiskSources","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/RiskAnalysisRiskSourceBulk"},{"$ref":"#/components/schemas/PortfolioRiskSourceBulk"}],"discriminator":{"propertyName":"riskSourceType","mapping":{"RISKANALYSIS":"#/components/schemas/RiskAnalysisRiskSourceBulk","PORTFOLIO":"#/components/schemas/PortfolioRiskSourceBulk"}}}}},"required":true},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/RiskAnalysisRiskSource"}},{"type":"array","items":{"$ref":"#/components/schemas/PortfolioRiskSource"}}],"discriminator":{"propertyName":"riskSourceType","mapping":{"RISKANALYSIS":"#/components/schemas/RiskAnalysisRiskSourceBulk","PORTFOLIO":"#/components/schemas/PortfolioRiskSourceBulk"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/risksources/bulk-delete":{"post":{"tags":["Risk Sources"],"summary":"Bulk delete risk sources","operationId":"bulkDeleteRiskSources","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["riskSourceUuids"],"properties":{"riskSourceUuids":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/risksources/{uuid}/imported-plt":{"parameters":[{"name":"uuid","in":"path","required":true,"description":"UUID of risk source.","schema":{"type":"string","format":"uuid"}}],"get":{"tags":["Risk Sources"],"summary":"Get PLT risk sources","operationId":"getPltRiskSources","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"periodId":{"type":"integer","format":"int32","example":503,"description":"ID of <<glossary:simulation period>>."},"eventId":{"type":"integer","format":"int64","description":"ID of event, a representation of a peril that may produce catastrophe losses.","example":3508644},"eventDate":{"type":"string","format":"date-time","description":"Date that the event occurred.","example":"2020-08-07T00:00:00.000Z"},"lossDate":{"type":"string","format":"date-time","description":"Date of first policy payout.","example":"2020-08-13T00:00:00.000Z"},"loss":{"type":"number","format":"double","description":"Mean loss incurred for event. Based on the granularity and financial perpective specified in the output profile.","example":111642.35349968076}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/risksources/{uuid}/imported-elt":{"parameters":[{"name":"uuid","in":"path","description":"UUID of risk source.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"tags":["Risk Sources"],"summary":"Get ELT risk sources","operationId":"getEltRisksources","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"integer","format":"int64","description":"ID of an event, a representation of a peril that may produce catastrophe losses.","example":2864907},"positionValue":{"type":"number","format":"double","description":"Mean loss incurred for event. Based on the granularity and financial perpective specified in the output profile.","example":182961890.62228483},"stdDevI":{"type":"number","format":"double","description":"Standard deviation from mean loss value.\n\nIndependent standard deviation assumes that all locations are completely independent, which means that knowing the size of the loss at one location does not provide any information about the size of the loss at the other location.","example":13084002.9308518},"stdDevC":{"type":"number","format":"double","description":"Standard deviation from mean loss value.\n\nCorrelated standard deviation assumes that all locations are correlated, which implies that if the losses are large for one location, they are likely to be large for the other location.","example":97423142.35982497},"expValue":{"type":"number","description":"Maximum loss that can be incurred for the event.","format":"double","example":3464996216.86613}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageWithDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/steppolicies":{"get":{"tags":["HD Step Policies"],"summary":"Search HD step policies","description":" ","operationId":"searchStepPolicies","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n|Property           |  Comparison                                         | List           |\n| ------------------ |  -------------------------------------------------- | -------------- |\n| `stepPolicyId`     |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `stepPolicyNumber` |  `=`, `!=`, `LIKE` `NOT LIKE`                       | `NOT IN`, `IN` |\n| `stepPolicyName`   |  `=`, `!=`, `LIKE` `NOT LIKE`                       | `NOT IN`, `IN` |\n| `accountId`        |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `stepOrderId`      |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `causeOfLoss`      |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `payoutAmount`     |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `share`            |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `excessAmount`     |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `NOT IN`, `IN` |\n| `currency`         |  `=`, `!=`, `LIKE` `NOT LIKE`                       | `NOT IN`, `IN` |\n| `isPerRiskSubject` |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `subjectFunction`  |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `payoutFunction`   |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `childOrderId`     |  `=`, `!=`, `LIKE` `NOT LIKE`                       | `NOT IN`, `IN` |\n| `coverageBase`     |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `limitGU`          |  `=`, `!=`, `<=`, `>=`, `>`, `<`, `LIKE` `NOT LIKE` | `NOT IN`, `IN` |\n| `inceptionDate`    |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    |                |\n| `expirationDate`   |  `=`, `!=`, `<=`, `>=`, `>`, `<`                    | `              |\n\nAll properties support creating compound queries using the `AND` and `OR` logical operators. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `accountId`, `causeOfLoss`, `childOrderId`, `coverageBase`, `currency`, `excessAmount`, `expirationDate`, `inceptionDate`, `isPerRiskSubject`, `limitGU`, `lobId`, `payoutAmount`, `payoutFunction`, `share`, `stepOrderId`, `stepPolicyId`, `stepPolicyName`, `stepPolicyNumber`, `subjectFunction`\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StepPolicy"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["HD Step Policies"],"summary":"Create HD step policy","description":" ","operationId":"createStepPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepPolicy"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new step policy","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/steppolicies/{id}":{"get":{"tags":["HD Step Policies"],"summary":"Get HD step policy","description":" ","operationId":"getStepPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of HD step policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Information on a specified step policy is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepPolicy"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["HD Step Policies"],"summary":"Update HD step policy","description":" ","operationId":"updateStepPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of step policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepPolicy"}}},"required":true},"responses":{"204":{"description":"Step policy successfully updated"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["HD Step Policies"],"summary":"Delete HD step policy","description":" ","operationId":"deleteStepPolicy","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of step policy.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Step policy successfully deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharesets":{"get":{"tags":["Share Sets"],"summary":"Search share sets","operationId":"SearchShareSets","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                  | Comparison                 | List          | \n| ------------------------- | -------------------------- | ------------- | \n|`uuid`                     |`=`                         | `IN`          |\n|`shareSetId`               |`=`                         | `IN`          |\n|`shareSetName`             |`=`                         | `IN`          |\n|`isActive`                 |`=`                         |         |\n|`isDefault`                |`=`                         |       |\n|`createdBy`                |`=`                         | `IN`          |\n|`updatedBy`                |`=`                         | `IN`          |\n|`isDataUploaded`           |`=`                         | `IN`          |\n\n\nThis parameter also supports logical operators (`AND`, `OR`) for defining compound expressions. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `shareSetId`, `shareSetName`, `createdBy`, `updatedBy`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShareSet"}}}},"headers":{"Location":{"description":"URL of the created resource","style":"simple","schema":{"type":"string","format":"URL"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Share Sets"],"summary":"Create share set","operationId":"createShareSet","requestBody":{"content":{"application/":{"schema":{"$ref":"#/components/schemas/ShareSet"}}},"required":true},"responses":{"201":{"description":"Created.","content":{"application/":{"schema":{"$ref":"#/components/schemas/ShareSetCreated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharesets/{id}":{"get":{"tags":["Share Sets"],"summary":"Get share set","operationId":"getShareSet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/":{"schema":{"$ref":"#/components/schemas/ShareSet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Share Sets"],"summary":"Delete share set","operationId":"softDelete_14","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict","content":{"application/":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Share Sets"],"summary":"Update share set","operationId":"updateShareSet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/":{"schema":{"type":"array","items":{"required":["targetProperty","value"],"type":"object","properties":{"operation":{"type":"string","enum":["UPDATE"]},"targetProperty":{"type":"string","enum":["shareSetName","description","isActive","isDefault"]},"value":{"type":"string"}}}}}}},"responses":{"204":{"description":"success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Validation issue","content":{"application/":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/sharesets/{id}/bulk-update-shares":{"post":{"tags":["Share Sets"],"summary":"Bulk update share set data","operationId":"bulkUpdateSharesetData","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/":{"schema":{"type":"array","items":{"required":["targetProperty","value"],"oneOf":[{"type":"object","required":["programId","treatyUuid","share"],"properties":{"programId":{"type":"integer","format":"int64"},"treatyUuid":{"type":"string","format":"uuid"},"share":{"type":"number","minimum":0,"maximum":1}}},{"type":"object","required":["programUuid","treatyUuid","share"],"properties":{"programUuid":{"type":"string","format":"uuid"},"treatyUuid":{"type":"string","format":"uuid"},"share":{"type":"number","minimum":0,"maximum":1}}}]}}}}},"responses":{"204":{"description":"success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Validation issue","content":{"application/":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties":{"get":{"tags":["Treaties"],"summary":"Search treaties","description":" ","operationId":"getTreatiesByFilters","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n| Property                | Type    | Comparison                      |\n| ----------------------- | ------- | ------------------------------- |\n| `aggregateDeductible`    | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `aggregateLimit`         | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `attachmentBasis`        | String  | `=`, `!=`,`LIKE`, `NOT LIKE`    |\n| `attachmentLevel`        | String  | `=`, `!=`,`LIKE`, `NOT LIKE`    |\n| `attachmentPoint`        | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `cedant`                 | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `currency`               | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `isValid`                | Boolean | `=`, `!=`                       |\n| `maolAmount`             | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `numberOfReinstatements` | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `occurrenceLimit`        | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `percentageCovered`      | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `percentagePlaced`       | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `percentageRetention`    | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `percentageRiShare`      | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `premium`                | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `priority`               | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `producer`               | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `reinstatementCharge`    | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `retentionAmount`        | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `riskLimit`              | Number  | `=`, `!=`, `<=`, `>=`, `>`, `<` |\n| `treatyId`              | Number  | `=`, `!=`, `<=` `>=` `>` `<`    |\n| `treatyName`             | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |            \n| `treatyNumber`           | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `treatyType`             | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `userId1`                | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n| `userId2`                | String  | `=`, `!=`, `LIKE`, `NOT LIKE`   |\n\n\nAll parameter support the `IN`, `NOT IN` list operators and the `AND` and `OR` logical operators. See [Filtering Responses](doc:response-filtering#treaties).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `aggregateDeductible`, `aggregateLimit`, `attachmentBasis`, `attachmentLevel`, `attachmentPoint`, `currency`, `isValid`, `maolAmount`, `numberOfReinstatements`, `occurrenceLimit`, `percentageCovered`, `percentagePlaced`, `percentageRetention`, `percentageRiShare`, `premium`, `priority`, `reinstatementCharge`, `retentionAmount`, `riskLimit`, `treatyId`, `treatyName`, `treatyNumber`, `treatyType`, `userId1`, `userId2`\n\nSee [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"List of treaties retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Treaty"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Treaties"],"summary":"Create treaty","description":" ","operationId":"createTreaty","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Treaty"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Treaty","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/{id}":{"get":{"tags":["Treaties"],"summary":"Get treaty","description":" ","operationId":"getTreaty","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Treaty retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Treaty"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Treaties"],"summary":"Update treaty","description":" ","operationId":"updateTreaty","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTreatyInfo"}}},"required":true},"responses":{"204":{"description":"Treaty updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Treaties"],"summary":"Delete treaty","operationId":"deleteTreaty","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Treaty deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/count":{"get":{"tags":["Treaties"],"summary":"Count treaties","description":" ","operationId":"getExposureCount","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Treaty count successfully retrieved.","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/{id}/lob":{"post":{"tags":["Treaties"],"summary":"Create treaty LOB","description":" ","operationId":"createTreatyLob","parameters":[{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineOfBusinessInfo"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"location of the new policy condition criteria","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/{id}/lob/{lobid}":{"get":{"tags":["Treaties"],"summary":"Get treaty LOB","description":" ","operationId":"getTreatyLob","parameters":[{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"lobid","in":"path","description":"ID of line of business.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Treaty line of business retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineOfBusiness"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Treaties"],"summary":"Delete treaty LOB","description":" ","operationId":"deleteTreatyLob","parameters":[{"name":"id","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"lobid","in":"path","description":"ID of line of business.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Treaty line of business deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/{treatyId}/lossoccurrences":{"get":{"tags":["Treaties"],"summary":"Get treaty loss occurrences","description":" ","operationId":"getLossOccurrences","parameters":[{"name":"treatyId","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of treaty loss occurrences retrieved.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LossOccurrence"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Treaties"],"summary":"Create treaty loss occurrence","description":"Returns the URL location of the created treaty loss occurrence resource","operationId":"createLossOccurrence","parameters":[{"name":"treatyId","in":"path","description":"ID of treaty.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LossOccurrence"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"treaty loss occurrence","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/treaties/{treatyId}/lossoccurrences/{lossOccurrenceId}":{"get":{"tags":["Treaties"],"summary":"Get treaty loss occurrence","description":" ","operationId":"getLossOccurrence","parameters":[{"name":"treatyId","in":"path","description":"ID of <<glossary:catastrophe treaty>>, <<glossary:corporate catastrophe treaty>>, or <<glossary:stop loss treaty>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"lossOccurrenceId","in":"path","description":"ID of treaty loss occurrence record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Treaty loss occurrences retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LossOccurrence"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Treaties"],"summary":"Update treaty loss occurrence","description":" ","operationId":"updateLossOccurrence","parameters":[{"name":"treatyId","in":"path","description":"ID of <<glossary:catastrophe treaty>>, <<glossary:corporate catastrophe>>, or <<glossary:stop loss treaty>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"lossOccurrenceId","in":"path","description":"ID of treaty loss occurrence record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LossOccurrence"}}},"required":true},"responses":{"204":{"description":"Treaty loss occurrence updated."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Treaties"],"summary":"Delete treaty loss occurrence","operationId":"deleteLossOccurrence","parameters":[{"name":"treatyId","in":"path","description":"ID of <<glossary:catastrophe treaty>>, <<glossary:corporate catastrophe>>, or <<glossary:stop loss treaty>>.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"lossOccurrenceId","in":"path","description":"ID of treaty loss occurrence record.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}},{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Treaty loss occurrence deleted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/underwriters":{"get":{"tags":["Underwriters"],"summary":"Search underwriters","operationId":"getUnderwriters","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property|Type|Comparison|List|Logical|\n|--------|----|----------|----|-------|\n|`underwriterId`|Number|`=`, `!=`, `<=`, `>=`, `>`, `<`|`IN`, NOT IN`|\n| `underwriterName`| String| `=`, `!=`, `LIKE`, `NOT LIKE` |`IN`, NOT IN`|\n\nBoth properties support creating compound queries using the `AND` and `OR` logical operators. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `underwriterId`, `underwriterName`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnderWriter"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Underwriters"],"summary":"Create underwriter","operationId":"createUnderwriter","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnderWriter"}}},"required":true},"responses":{"201":{"description":"Created.","headers":{"Location":{"description":"Location of the new underwriter","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"409":{"description":"Conflict. Resource already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/exposures/{exposureId}/underwriters/{id}":{"get":{"tags":["Underwriters"],"summary":"Get underwriter","operationId":"getUnderwriterById","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of underwriter.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnderWriter"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Underwriters"],"summary":"Update underwriter","operationId":"updateUnderwriter","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of underwriter.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnderWriter"}}},"required":true},"responses":{"204":{"description":"UnderWriter is updated in the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Underwriters"],"summary":"Delete underwriter","operationId":"deleteUnderwriter","parameters":[{"name":"exposureId","in":"path","description":"ID of EDM.","required":true,"schema":{"minimum":1,"type":"integer","format":"int64"}},{"name":"id","in":"path","description":"ID of underwriter.","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Underwriter is deleted from the exposure successfully."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"schemas":{"RollupPricingMetricsOutput":{"type":"array","items":{"type":"object","properties":{"positionName":{"type":"string","example":"treaty1"},"positionUuid":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"positionType":{"type":"string","example":"Corporate"},"pricingType":{"type":"string","example":"Treaty"},"price":{"type":"number","example":4645.46},"capital":{"type":"number","example":5995.4},"rateOnLine":{"type":"number","example":156.9},"lossOnLineMean":{"type":"number","example":15745.4},"lossOnLineStdDev":{"type":"number","example":588.4},"probabilityOfAttachment":{"type":"number","example":0.85},"probabilityOfExhaustion":{"type":"number","example":0.4},"probabilityOfBreakEven":{"type":"number","example":0.15},"combinedRatioMean":{"type":"number","example":486.4},"combinedRatioStdDev":{"type":"number","example":464.4},"returnOnCapitalMean":{"type":"number","example":5646.4},"returnOnCapitalStdDev":{"type":"number","example":484.8},"riskMeasures":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string","example":"Z"},"name":{"type":"string"},"value":{"type":"number","example":105676.4525}}}},"customMeasures":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"name":{"type":"string"},"formula":{"type":"string"},"value":{"type":"number"}}}}}}},"RollupEpMetricsOutput":{"type":"object","properties":{"positionName":{"type":"string"},"positionType":{"type":"string"},"positionUuid":{"type":"string","format":"uuid"},"nodeSubtype":{"type":"string","enum":["PORTFOLIO","PROGRAM","GROUP","TREATY","RISK_ANALYSIS","RISK_BLOCK","PLT","PORTFOLIO_VARIATION"]},"scenarioName":{"type":"string"},"scenarioUuid":{"type":"string","format":"uuid"},"treaty":{"type":"object","properties":{"treatyUuid":{"type":"string","format":"uuid"},"treatyName":{"type":"string"},"programName":{"type":"string"},"share":{"type":"number"},"programSetName":{"type":"string"},"programSetCedant":{"type":"string"},"cedenceType":{"type":"string"},"currencyCode":{"type":"string"},"templateCode":{"type":"string"},"occurrenceLimitAmount":{"type":"number"},"aggregateLimitAmount":{"type":"number"}}},"oep":{"type":"array","items":{"type":"object","properties":{"returnPeriod":{"type":"number"},"value":{"type":"number","format":"double"}}}},"aep":{"type":"array","items":{"type":"object","properties":{"returnPeriod":{"type":"number"},"value":{"type":"number","format":"double"}}}},"tceOep":{"type":"array","items":{"type":"object","properties":{"returnPeriod":{"type":"number"},"value":{"type":"number","format":"double"}}}},"tceAep":{"type":"array","items":{"type":"object","properties":{"returnPeriod":{"type":"number"},"value":{"type":"number","format":"double"}}}}}},"RollupKeyLossesOutput":{"type":"object","properties":{"positionName":{"type":"string"},"positionType":{"type":"string","enum":["Treaty","TreatySubject","RiskBlock","RetroTreaty","RetroTreatySubject","TreatyAlt","TreatySubjectAlt","MarginalImpact","PortfolioMarginalImpact","Program","Node","Gross","Net","PreMarginalImpact","Ceded","Assumed","TreatyAssumed","ReinstatementPremium","TreatyNetReinstatementPremium","TreatyNetReinstatementDepositPremium","RiskBlockNetReinstatementPremium","RiskBlockNetReinstatementDepositPremium","ProgramNetReinstatementPremium","ProgramNetReinstatementDepositPremium","RetroTreatyNetReinstatementPremium","RetroTreatyNetReinstatementDepositPremium","NodeNetReinstatementPremium","NodeNetReinstatementDepositPremium","OutwardsNetReinstatementPremium","OutwardsNetReinstatementDepositPremium","NetNetReinstatementDepositPremium","NetNetReinstatementPremium"]},"positionUuid":{"type":"string","format":"uuid"},"nodeSubtype":{"type":"string","enum":["PORTFOLIO","PROGRAM","GROUP","TREATY","RISK_ANALYSIS","RISK_BLOCK","PLT","PORTFOLIO_VARIATION"]},"scenarioName":{"type":"string"},"scenarioUuid":{"type":"string","format":"uuid"},"treaty":{"type":"object","properties":{"treatyUuid":{"type":"string","format":"uuid"},"treatyName":{"type":"string"},"programName":{"type":"string"},"share":{"type":"number"},"programSetName":{"type":"string"},"programSetCedant":{"type":"string"},"cedenceType":{"type":"string"},"currencyCode":{"type":"string"},"templateCode":{"type":"string"},"occurrenceLimitAmount":{"type":"number"},"aggregateLimitAmount":{"type":"number"}}},"mean":{"type":"number","example":238473.46211845864,"description":"The mean loss represents the expected loss for treaty in scenario.  "},"stdDev":{"type":"number","example":237044.1732530523,"description":"The standard deviation of a `meanLoss` value characterizes the secondary uncertainty associated with that `meanLoss` value, i.e. the uncertainty in an event loss."},"cv":{"type":"number","example":0.9940065076729738},"probabilityOfAttachment":{"type":"number","description":"Probability that treaty will take loss in scenario.","example":0.656},"probabilityOfExhaustion":{"type":"number","example":0.155,"description":"Probability that losses from event in scenario will exhaust treaty layer."}}},"ReportViewAnalysis":{"type":"object","properties":{"analysisId":{"type":"integer","description":"ID of analysis result.","format":"int64","example":567},"appAnalysisId":{"type":"integer","description":"ID of analysis result in Risk Modeler/UnderwriteIQ application.","format":"int64","example":2971},"analysisName":{"type":"string","description":"Name of analysis result.","example":"BatchAPI_EDM_wRefData_PSC: ACCOUNT: Global Acct 100K v2"},"analysisDescription":{"type":"string","description":"Description of analysis result.","example":"RM2.0_API_JPEQ_V24"},"analysisCurrency":{"type":"object","description":"Currency used to calculate losses in analysis result.","properties":{"name":{"type":"string","description":"Name of currency used to calculate losses.","example":"US Dollar"},"code":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"scheme":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"asOfDate":{"type":"string","description":"Effective date of currency scheme in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`.","example":"2020-01-01T00:00:00.000Z"},"vintage":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL24"}}},"analysisType":{"type":"string","description":"Type of analysis result.","example":"DLM","enum":["DLM","HD","GROUP","GROUP_HD","MARGINAL_IMPACT","MARGINAL_IMPACT_HD","GROUP_MARGINAL_IMPACT","GROUP_MARGINAL_IMPACT_HD"]},"analysisFramework":{"type":"string","description":"Framework used in analysis result.","enum":["ELT","PLT"],"example":"ELT"},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss. One of: `CS/WT` (Severe Convective Storm and Winterstorm), `EQ` (Earthquake), `FL` (Flood), `FR` (Fire), `TR` (Terrorism), `WC` (Workers Compensation), `WS` (Windstorm).","example":"EQ"},"region":{"type":"string","description":"Two letter code of region analyzed, e.g. `AU`, `CB`, `AC`, `CC`. See [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)","example":"JP"},"referenceAnalysisId":{"type":"integer","format":"int64","example":41212,"description":"ID of <<glossary:reference analysis>> used in <<glossary:marginal impact report>>."},"referenceAppAnalysisId":{"type":"integer","description":"ID of analysis result in Risk Modeler / UnderwriteIQ application. ","format":"int64","example":2214},"referenceAnalysisName":{"type":"string","description":"Name of <<glossary:reference analysis>> used in <<glossary:marginal impact report>>.","example":"Global Reference Analysis Group"},"referenceAnalysisDescription":{"type":"string","description":"Description of reference analysis."},"metricTypes":{"uniqueItems":true,"description":"List of metric types: `ELT`, `EP`, `EXPOSURE_SUMMARY`, `GROUP_ELT`, `GROUP_EP`, `GROUP_MARGINAL_EP`, `GROUP_MARGINAL_STATS`, `GROUP_PLT`, `GROUP_POLICY_EP`, `GROUP_POLICY_STATS`, `GROUP_STATS`, `LOCATION_AAL`, `LOCATION_RESULTS`, `MARGINAL_EP`, `MARGINAL_STATS`, `PLT`, `POLICY_EP`, `POLICY_STATS`, `STATS`","type":"array","example":["POLICY_EP","EP","STATS","POLICY_STATS","ELT","MARGINAL_STATS","MARGINAL_EP"],"items":{"type":"string","enum":["ELT","EP","EXPOSURE_SUMMARY","GROUP_ELT","GROUP_EP","GROUP_MARGINAL_EP","GROUP_MARGINAL_STATS","GROUP_PLT","GROUP_POLICY_EP","GROUP_POLICY_STATS","GROUP_STATS","LOCATION_AAL","LOCATION_RESULTS","MARGINAL_EP","MARGINAL_STATS","PLT","POLICY_EP","POLICY_STATS","STATS","ACCUMULATIONS_BY_POLICY","ACCUMULATIONS_BY_LOCATION","ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY","ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1","ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2","ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE","ACCUMULATIONS_BY_TREATY","ACCUMULATION_EVENTS"]}}}},"ComplexPolicyConditionCriteria":{"required":["field","operator","value"],"type":"array","items":{"type":"object","properties":{"closePar":{"type":"string","description":"Closing parenthesis in compound query. One of `)`, `))`, `)))`","example":")","enum":[")","))",")))"]},"field":{"type":"string","description":"Property to be searched in query.","example":"COUNTRY"},"logic":{"type":"string","description":"Logical operator in compound query. One of `AND`, `OR`.","example":"AND","enum":["AND","OR"]},"openPar":{"type":"string","description":"Opening parenthesis in compound query. One of `(`, `((`, `(((`.","enum":["(","((","((("],"example":"("},"operator":{"type":"string","description":"Comparision operator in query. One of `=`, `>`, `<`, `>=`.","enum":["=",">","<",">="],"example":"="},"value":{"type":"string","description":"Value of `field` property.","example":"US"}}}},"ShareSet":{"required":["createdAt","createdBy","description","isActive","isDataUploaded","isDefault","modifiedAt","modifiedBy","shareSetId","shareSetName","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"UUID of share set.","format":"uuid","readOnly":true},"shareSetId":{"type":"integer","description":"ID of share set.","format":"int32","readOnly":true},"shareSetName":{"type":"string","description":"Name of share set."},"description":{"type":"string","description":"Description of share set."},"isActive":{"type":"boolean","description":"Status of share set."},"isDefault":{"type":"boolean"},"isDataUploaded":{"type":"boolean","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true}}},"PolicyConditionCriterias":{"type":"object","properties":{"policyConditionCriterias":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"}}}}}},"ShareSetCreated":{"required":["shareSetId","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID of share set."},"shareSetId":{"type":"integer","format":"int32","description":"ID of share set."}}},"ProgramVariationSummary":{"required":["programVariationName","source","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid","readOnly":true},"programVariationId":{"type":"integer","format":"int64","readOnly":true},"programUuid":{"type":"string","format":"uuid","readOnly":true},"programId":{"type":"integer","format":"int64","readOnly":true},"uri":{"type":"string","format":"uri","readOnly":true},"programVariationName":{"type":"string"},"description":{"type":"string"},"source":{"type":"string","enum":["Original","Reset","Renewal"]},"resetYear":{"type":"string"},"tags":{"description":"List of <<data tag>> IDs to apply to this program.","type":"array","items":{"type":"string"}},"status":{"description":"Status of this program.","type":"string","enum":["Draft","Finalized"]},"notes":{"description":"Notes regarding this program.","type":"string"},"templateName":{"type":"string"},"currencyCode":{"description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_.","type":"string"},"quoteStatus":{"description":"Current stage of this program's underwriting process.","type":"string","enum":["Cancelled","New","Quote","Signed","Written"]},"defaultStartDate":{"description":"Default start date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"defaultEndDate":{"description":"Default end date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"organization":{"description":"Details about the organization attached to this program.","$ref":"#/components/schemas/ProgramOrganization"},"brokerage":{"description":"Amount paid to a reinsurer to participate in this program.","type":"number"},"otherVariableExpense":{"type":"number"},"customProgramLabel1":{"type":"string"},"customProgramLabel2":{"type":"string"},"customProgramLabel3":{"type":"string"},"customProgramLabel4":{"type":"string"},"programSetSummary":{"description":"Details about the parent program set.","$ref":"#/components/schemas/ProgramSetSummary"},"businessHierarchySetSummary":{"description":"Details about the attached business hierarchy set.","$ref":"#/components/schemas/BusinessHierarchySetSummary"},"treatiesCount":{"description":"Number of program treaties (contracts) attached to this program.","type":"number","readOnly":true},"createdBy":{"description":"Login of <<glossary:principal>> that created program, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","type":"string","format":"email","example":"user.name@company.com","readOnly":true},"createdAt":{"description":"Date program was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z","type":"string","format":"date-time","readOnly":true}}},"ProgramVariation":{"required":["name","programSetId","source"],"allOf":[{"$ref":"#/components/schemas/ProgramBase"},{"type":"object","properties":{"riskSources":{"type":"array","items":{"$ref":"#/components/schemas/ProgramRiskSource"}}}}]},"DisplayColumn":{"required":["name"],"type":"object","properties":{"name":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DisplayColumnItem"}}}},"DisplayColumnItem":{"required":["name","type"],"type":"object","properties":{"type":{"type":"string","enum":["CONTRACT","RISK_BLOCK"]},"name":{"type":"string"}}},"ProgramSetSummary":{"required":["name","programSetUuid"],"type":"object","readOnly":true,"properties":{"programSetId":{"type":"number"},"name":{"type":"string"},"cedenceType":{"type":"string","enum":["Inward","Outwards"]},"cedant":{"type":"string","description":"Name of the <<glossary:cedant>>."},"underwriter":{"type":"string","description":"Name of the <<glossary:underwriter>>."},"reference":{"type":"string"},"primeProgramId":{"type":"number"}}},"BusinessHierarchySetSummary":{"type":"object","readOnly":true,"properties":{"businessHierarchySetName":{"type":"string","description":"Name of this business hierarchy set.","readOnly":true},"businessHierarchySetId":{"type":"integer","description":"User-defined ID of this business hierarchy set.","format":"int64","readOnly":true},"businessOwner":{"type":"string","readOnly":true},"primeBusinessHierarchyId":{"type":"integer","description":"ID of <<glossary:prime business hierarchy>>.","format":"int64","readOnly":true}}},"SubjectOfLoss":{"required":["lossFlowType","subjectUuid","subjectType"],"type":"object","properties":{"subjectUuid":{"type":"string","description":"Source or exposure uuid","format":"uuid"},"subjectType":{"type":"string","enum":["BUSINESS_HIERARCHY_POSITION","TREATY","PORTFOLIO","RISK_ANALYSIS","PROGRAM","RISK_BLOCK","PLT","PORTFOLIO_VARIATION"]},"riskAnalysisType":{"type":"string","enum":["ALM","DLM","GROUP","HD"]},"lossFlowType":{"type":"string","description":"Loss flow type","example":"netloss","enum":["netloss","payout"]},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  \n"},"weight":{"$ref":"#/components/schemas/BigDecimal"},"perilIds":{"type":"array","description":"List of <<glossary:peril>>s by ID.","items":{"type":"integer","format":"int64"}},"regions":{"type":"array","items":{"$ref":"#/components/schemas/TreatyRegion"}},"lobIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"description":"Contract subject (risk data)"},"TreatyRegion":{"required":["regionId","regionType"],"type":"object","properties":{"regionId":{"type":"integer","description":"ID of region.","format":"int64"},"regionType":{"type":"string","description":"Type of region.","enum":["admin1","country","continent"]}},"description":"Region of treaty."},"TreatyAttribute":{"required":["inceptionStatus","quote","treatyType"],"type":"object","properties":{"quote":{"type":"boolean","description":"Treaty quote"},"treatyType":{"type":"string","description":"Type of treaty.","example":"CatXL","enum":["CatXL","Custom","FHCF","QuotaShare","TopAndDrop"]},"inceptionStatus":{"type":"string","description":"Inception status","example":"Incepting","enum":["NotSigned","Incepting","Live","Expired","Expiring"]},"occurrenceAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"occurrenceLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"occurrenceFranchise":{"type":"boolean","description":"Occurrence franchise"},"aggregateAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"aggregateLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"aggregateFranchise":{"type":"boolean","description":"Aggregate franchise"},"share":{"$ref":"#/components/schemas/BigDecimal"},"customCdl":{"type":"string","description":"Custom CDL"},"placement":{"$ref":"#/components/schemas/BigDecimal"},"cedant":{"type":"string","description":"Name of the <<glossary:cedant>>."},"underwriter":{"type":"string","description":"Name of the treaty underwriter."},"reinstatements":{"type":"array","items":{"$ref":"#/components/schemas/TreatyReinstatement"}},"subs":{"type":"array","items":{"$ref":"#/components/schemas/TreatySubAttribute"}},"subjectPremium":{"$ref":"#/components/schemas/BigDecimal"},"lossRatioCap":{"$ref":"#/components/schemas/BigDecimal"},"cedingCommission":{"$ref":"#/components/schemas/BigDecimal"},"brokerage":{"$ref":"#/components/schemas/BigDecimal"},"otherVariableExpense":{"type":"number"},"payoutType":{"type":"string","enum":["BINARY","PRORATA"]},"payout":{"$ref":"#/components/schemas/BigDecimal"},"triggerType":{"type":"string","enum":["Layer","K"]},"triggerOccurrenceAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"triggerOccurrenceLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"triggerCriteria":{"type":"string","enum":["ATTACHES","EXHAUSTS"]},"triggerK":{"type":"integer","description":"Trigger K","format":"int32"},"triggerLayerResponse":{"type":"string","enum":["DROPS","ACTIVATES"]},"postTriggerAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"postTriggerLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"fhcf":{"$ref":"#/components/schemas/TreatyFhcfAttribute"},"layers":{"type":"array","items":{"$ref":"#/components/schemas/TreatyAttributeLayer"}},"exclusions":{"type":"array","items":{"$ref":"#/components/schemas/TreatyAttributeExclusion"}},"clauses":{"type":"array","items":{"$ref":"#/components/schemas/TreatyAttributeClause"}}},"description":"Contract treaty attributes"},"TreatyAttributeClause":{"required":["durationInHours","perilId","sameEventReinstatements"],"type":"object","properties":{"perilId":{"type":"integer","format":"int64","description":"ID of <<glossary:peril>>>"},"durationInHours":{"type":"integer","format":"int32"},"sameEventReinstatements":{"type":"boolean"}},"description":"Clauses"},"TreatyAttributeExclusion":{"required":["exclusionType"],"type":"object","properties":{"exclusionType":{"type":"string","enum":["EXCLUDE","INCLUDE"]},"regionType":{"type":"string","default":"country","enum":["admin1","country","continent"]},"perilIds":{"type":"array","description":"List of <<glossary:peril>>s by ID.","items":{"type":"integer","format":"int64"}},"regionIds":{"type":"array","items":{"type":"integer","format":"int64"}},"lobIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"description":"Exclusions"},"TreatyAttributeLayer":{"type":"object","properties":{"occurrenceAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"occurrenceLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"occurrenceFranchise":{"type":"boolean","description":"Occurrence franchise"},"aggregateAttachmentAmount":{"$ref":"#/components/schemas/BigDecimal"},"aggregateFranchise":{"type":"boolean","description":"Aggregate franchise"},"aggregateLimitAmount":{"$ref":"#/components/schemas/BigDecimal"},"number":{"type":"integer","description":"Layer number","format":"int32"}},"description":"Layers"},"TreatyReinstatement":{"required":["reinstatementType"],"type":"object","properties":{"count":{"type":"string","description":"Reinstatement count"},"reinstatementType":{"type":"string","description":"Reinstatement type","example":"Free","enum":["Free","Paid"]},"premiumRate":{"$ref":"#/components/schemas/BigDecimal"},"proRataOption":{"type":"string","description":"Pro-rata option"}},"description":"Contract reinstatement"},"TreatySubAttribute":{"required":["amount","isAggregate","isFranchise","type"],"type":"object","properties":{"type":{"type":"string","enum":["SUBLIMIT","SUBEXCESS"]},"perilIds":{"type":"array","items":{"type":"integer","format":"int64"}},"regionType":{"type":"string","enum":["admin1","country","continent"]},"regionIds":{"type":"array","items":{"type":"integer","format":"int64"}},"lobIds":{"type":"array","items":{"type":"integer","format":"int64"}},"amount":{"$ref":"#/components/schemas/BigDecimal"},"isAggregate":{"type":"boolean","description":"Is aggregate"},"isFranchise":{"type":"boolean","description":"Is franchise"}},"description":"Contract treaty sub-attributes"},"TreatyFhcfAttribute":{"type":"object","properties":{"coverageLevel":{"$ref":"#/components/schemas/BigDecimal"},"retention":{"$ref":"#/components/schemas/BigDecimal"},"limit":{"$ref":"#/components/schemas/BigDecimal"}},"description":"FHCF parameters"},"BusinessHierarchyVariation":{"type":"object","allOf":[{"$ref":"#/components/schemas/BusinessHierarchyVariationSummary"},{"type":"object","properties":{"positions":{"type":"array","description":"List of financial positions within this business hierarchy.","items":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["PORTFOLIO","PROGRAM","GROUP"]},"description":{"type":"string"},"index":{"type":"integer","format":"int32","readOnly":true},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  "},"count":{"type":"integer","format":"int32","readOnly":true},"positionUuid":{"type":"string","format":"uuid","readOnly":true},"positions":{"description":"List of business hierarchies in this business hierarchy.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/BusinessHierarchyPosition"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchyMember"}}}}}}}]},"BusinessHierarchyPosition":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["PORTFOLIO","PROGRAM","GROUP"]},"description":{"type":"string"},"index":{"type":"integer","format":"int32","readOnly":true},"perspectiveCode":{"type":"string"},"count":{"type":"integer","format":"int32","readOnly":true},"positionUuid":{"type":"string","format":"uuid","readOnly":true},"positions":{"description":"List of business hierarchies in this business hierarchy.","type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchyPosition"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchyMember"}}}},"BusinessHierarchyMember":{"required":["referenceId","type"],"type":"object","properties":{"type":{"type":"string","enum":["PORTFOLIO","PROGRAM"]},"referenceUuid":{"type":"string","format":"uuid"}}},"BusinessHierarchyVariationSummary":{"type":"object","required":["businessHierarchyVariationName","businessHierarchyId","businessHierarchyVariationId"],"properties":{"businessHierarchyId":{"type":"integer","format":"int64","readOnly":true},"businessHierarchyVariationName":{"type":"string"},"businessHierarchyVariationId":{"type":"integer","format":"int64","readOnly":true},"uri":{"type":"string","format":"uri","readOnly":true},"uuid":{"type":"string","format":"uuid","readOnly":true},"createdBy":{"type":"string","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"reference":{"type":"string"},"outwardsReinsuranceProgramVariationId":{"type":"integer","nullable":true},"businessHierarchySetSummary":{"$ref":"#/components/schemas/BusinessHierarchySetSummary"},"nodeCount":{"type":"integer","readOnly":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true}}},"ReportView":{"type":"object","properties":{"reportViewId":{"type":"integer","description":"ID of report view.","format":"int64","example":694},"reportViewName":{"type":"string","description":"Name of report view.","example":"IMPORT_EDM_RM"},"exposureName":{"type":"string","description":"Name of EDM.","example":"IMPORT_EDM_RM"},"createdAt":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2023-04-03T03:19:26.445Z"},"exposureResourceId":{"type":"integer","description":"ID of analyzed exposure.","format":"int32","example":673},"exposureResourceType":{"type":"string","description":"Type of analyzed exposure.","example":"ACCOUNT","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"createdBy":{"type":"string","description":"Name of principal that created the report.","example":"user.name@company.com"},"notes":{"type":"string","description":"Notes about the report view.","example":"IMPORT_EDM_RM: ACCOUNT: NAEQ-JSON"},"reportDetails":{"type":"array","description":"Detailed information about metrics, statisitcs, loss tables, and reports included in report view.\n\nContent of report view depends on the tasks specfiied in Create Batch Job that generated the report view.","items":{"$ref":"#/components/schemas/ReportViewDetails"}}}},"ReportViewDetails":{"type":"object","properties":{"metricType":{"type":"string","description":"Type of metric, statistic, loss table, or report.","example":"ELT","enum":["ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1","ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2","ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY","ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE","ACCUMULATIONS_BY_LOCATION","ACCUMULATIONS_BY_POLICY","ACCUMULATIONS_BY_TREATY","ACCUMULATION_EVENTS","ELT","EP","EXPOSURE_SUMMARY","GROUP_ELT","GROUP_EP","GROUP_MARGINAL_EP","GROUP_MARGINAL_STATS","GROUP_PLT","GROUP_POLICY_EP","GROUP_POLICY_STATS","GROUP_STATS","LOCATION_AAL","LOCATION_RESULTS","MARGINAL_EP","MARGINAL_STATS","PLT","POLICY_EP","POLICY_STATS","STATS"]},"analysisId":{"type":"integer","description":"ID of analysis result.\n\nNot returned if `metricType` is `EXPOSURE_SUMMARY` or `LOCATION_RESULTS`.","example":3040252,"format":"int64"},"metricUrl":{"type":"string","description":"URL of analysis result or report.\n\n- If `ELT`, `EP`, `STATS` or other metric produced by model job, returns URL of analysis result.\n- `EXPOSURE_SUMMARY` or `LOCATION_RESULTS`, returns URL of downloadable report.","example":"https://host/platform/riskdata/v1/analyses/3040252/elt?perspectiveCode=GR&exposureResourceId=XXX&exposureResourceType=ACCOUNT"},"additionalInfo":{"type":"object","description":"Content depends on `metricType`.\n\n- If `ELT`, `EP`, `STATS` or other metric produced by model job, returns information about model job: `peril`, `region`, ``analysisName`.\n- If `EXPOSURE_SUMMARY`  or `LOCATION_RESULTS`, returns `reportUuid`.  ","example":{"peril":"EQ","region":"NA","analysisName":"IMPORT_EDM_RM: ACCOUNT: NAEQ-JSON"},"additionalProperties":{"type":"object"}}}},"ReportViewSummary":{"type":"object","properties":{"reportViewId":{"type":"integer","description":"ID of report view.","example":6808,"format":"int64"},"reportViewName":{"description":"Name of report view.","example":"FL_int_17countries","type":"string"},"exposureName":{"description":"Name of EDM.","type":"string","example":"IMPORT_EDM_RM"},"createdAt":{"type":"string","description":"Date report was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-10-08T22:49:55.693Z"},"exposureId":{"description":"ID of EDM.","type":"integer","format":"int64","example":10171},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113},"exposureResourceType":{"type":"string","example":"ACCOUNT","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"exposureResourceTypeId":{"type":"integer","format":"int32","example":2156264},"createdBy":{"type":"string","description":"Email address of <<glossary:principal>> that created the report view.","example":"user.name@company.com"},"notes":{"type":"string","description":"Notes regarding report view."},"metricTypes":{"type":"array","example":["STATS","ELT","EP"],"items":{"type":"string","enum":["ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1","ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2","ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY","ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE","ACCUMULATIONS_BY_LOCATION","ACCUMULATIONS_BY_POLICY","ACCUMULATIONS_BY_TREATY","ACCUMULATION_EVENTS","ELT","EP","EXPOSURE_SUMMARY","GROUP_ELT","GROUP_EP","GROUP_MARGINAL_EP","GROUP_MARGINAL_STATS","GROUP_PLT","GROUP_POLICY_EP","GROUP_POLICY_STATS","GROUP_STATS","LOCATION_AAL","LOCATION_RESULTS","MARGINAL_EP","MARGINAL_STATS","PLT","POLICY_EP","POLICY_STATS","STATS"]}}}},"BusinessHierarchy":{"type":"object","allOf":[{"$ref":"#/components/schemas/BusinessHierarchySummary"},{"type":"object","properties":{"primeAnalysisId":{"type":"integer","nullable":true}}},{"type":"object","properties":{"positions":{"type":"array","items":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["PROGRAM","GROUP","RISK_SOURCE"]},"description":{"type":"string"},"index":{"type":"integer","format":"int32","readOnly":true},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  "},"count":{"type":"integer","format":"int32","readOnly":true},"positionUuid":{"type":"string","format":"uuid","readOnly":true},"positions":{"description":"List of financial positions in this business hierarchy.","type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/BusinessHierarchyPosition"}},"members":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHierarchyMember"}}}}}}}]},"BusinessHierarchySummary":{"type":"object","required":["businessHierarchyName"],"properties":{"businessHierarchyName":{"type":"string","description":"Name of this business hierarchy"},"businessHierarchyId":{"type":"integer","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of this business hierarchy."},"uri":{"type":"string","format":"uri","readOnly":true},"uuid":{"type":"string","format":"uuid","readOnly":true},"isPrime":{"type":"boolean","description":"If `true`, this is the primary business hierarchy in the business hierarchy set.","default":"false","nullable":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","readOnly":true},"reference":{"type":"string"},"outwardsReinsuranceProgramId":{"type":"integer","description":"ID of outward program. Business hierarchy set secures this outward program.","nullable":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true},"businessHierarchySetSummary":{"$ref":"#/components/schemas/BusinessHierarchySetSummary"},"nodeCount":{"description":"Number of positions in this business hierarchy.","type":"integer","readOnly":true}}},"ProgramRiskSource":{"type":"object","properties":{"riskSourceUuid":{"type":"string","format":"uuid"},"riskSourceType":{"type":"string","readOnly":true,"enum":["PORTFOLIO","RISK_ANALYSIS","PLT","PORTFOLIO_VARIATION"]},"riskAnalysisType":{"type":"string","readOnly":true,"enum":["ALM","DLM","GROUP","HD"]}}},"RiskAnalysisRiskSourceBulk":{"type":"object","required":["riskSourceType","parentType","riskSources"],"properties":{"riskSourceType":{"type":"string","enum":["RISKANALYSIS"]},"parentType":{"type":"string","enum":["PROGRAM","BUSINESSHIERARCHYPOSITION"]},"parentId":{"type":"integer","format":"int64"},"parentUuid":{"type":"string","format":"uuid"},"riskSources":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/RiskAnalysisRiskSource"}}}},"PortfolioRiskSourceBulk":{"type":"object","required":["riskSourceType","parentType","riskSources"],"properties":{"riskSourceType":{"type":"string","enum":["PORTFOLIO"]},"parentType":{"type":"string","enum":["PROGRAM","BUSINESSHIERARCHYPOSITION"]},"parentId":{"type":"integer","format":"int64"},"parentUuid":{"type":"string","format":"uuid"},"riskSources":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/PortfolioRiskSource"}}}},"PortfolioVariationRiskSourceBulk":{"type":"object","required":["riskSourceType","parentType","riskSources"],"properties":{"riskSourceType":{"type":"string","enum":["PORTFOLIOVARIATION"]},"parentType":{"type":"string","enum":["PROGRAM","BUSINESSHIERARCHYPOSITION"]},"parentId":{"type":"integer","format":"int64"},"parentUuid":{"type":"string","format":"uuid"},"riskSources":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/PortfolioVariationRiskSource"}}}},"RiskAnalysisRiskSource":{"required":["perspectiveCode","analysisId","riskSourceUuid"],"type":"object","properties":{"riskSourceUuid":{"type":"string","format":"uuid","readOnly":true},"analysisId":{"type":"integer","format":"int64"},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  "},"name":{"type":"string"},"description":{"type":"string"},"segments":{"type":"array","items":{"type":"string","enum":["country","admin1"]}},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int32"}},"addPortfolio":{"type":"boolean","default":false},"tile":{"type":"boolean","description":"If `true`, the PLT data returned in response is \"tiled\" (extrapolated) if date range or period ranges are insufficient to match the simulation settings of the analysis. Enables clients to model the risk to treaties, if the dates of the underlying loss tables do not align with the treaty dates, without the need to apply workarounds.","default":false}}},"PortfolioRiskSource":{"required":["exposureId","portfolioId","riskSourceUuid"],"type":"object","properties":{"riskSourceUuid":{"type":"string","format":"uuid","readOnly":true},"exposureId":{"type":"integer","format":"int64"},"portfolioId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"treatyIds":{"type":"array","description":"List of treaties.","uniqueItems":true,"items":{"type":"integer","format":"int32"}}}},"PortfolioVariationRiskSource":{"required":["riskSourceUuid","analysisId","portfolioVariationId"],"type":"object","properties":{"riskSourceUuid":{"type":"string","format":"uuid","readOnly":true},"portfolioVariationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int32"}}}},"ProgramSummary":{"required":["programName","source","uuid"],"type":"object","properties":{"uuid":{"description":"System-defined UUID of this program.","type":"string","format":"uuid","readOnly":true},"programId":{"description":"User-defined ID of this program.","type":"integer","format":"int64","readOnly":true},"uri":{"type":"string","description":"Resource URI of this program. See [Resource URIs](doc:resource-uris)","format":"uri","readOnly":true},"programName":{"type":"string","description":"Must be unique within program set"},"description":{"description":"Description of this program","type":"string"},"source":{"type":"string","enum":["Original","Reset","Renewal"]},"resetYear":{"type":"integer","format":"int32"},"tags":{"description":"List of <<glossary:data tag>> IDs to apply to this program.","type":"array","items":{"type":"string"}},"status":{"description":"Status of this program.","type":"string","enum":["Draft","Finalized"]},"notes":{"type":"string","description":"Notes regarding this program."},"templateName":{"description":"Name of contract template that defines program.","type":"string"},"currencyCode":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"quoteStatus":{"description":"Current stage of the program's underwriting process.","type":"string"},"defaultStartDate":{"description":"Default start date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"defaultEndDate":{"description":"Default end date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"organization":{"description":"Details about the organization attached to this program.","$ref":"#/components/schemas/ProgramOrganization"},"brokerage":{"type":"number","description":"Amount paid to a reinsurer to participate in this program"},"otherVariableExpense":{"type":"number","description":"Other expenses, e.g. legal fees."},"customProgramLabel1":{"description":"Custom metadata for program, business hierarchy, or program treaty. ","type":"string"},"customProgramLabel2":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"customProgramLabel3":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"customProgramLabel4":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"programSetSummary":{"$ref":"#/components/schemas/ProgramSetSummary"},"businessHierarchySetSummary":{"$ref":"#/components/schemas/BusinessHierarchySetSummary"},"isPrime":{"type":"boolean","default":"false","description":"If `true` this is the main program between the insurer and cedant.","nullable":true},"treatiesCount":{"type":"number","readOnly":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","readOnly":true},"materialModifiedAt":{"type":"string","format":"date-time","readOnly":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true}}},"ProgramSummarySaveAsNew":{"required":["programName"],"type":"object","properties":{"uuid":{"description":"System-defined UUID of this program.","type":"string","format":"uuid","readOnly":true},"programId":{"description":"User-defined ID of this program.","type":"integer","format":"int64","readOnly":true},"uri":{"type":"string","description":"Resource URI of this program. See [Resource URIs](doc:resource-uris)","format":"uri","readOnly":true},"programName":{"type":"string","description":"Must be unique within program set"},"description":{"description":"Description of this program","type":"string"},"source":{"type":"string","enum":["Original","Reset","Renewal"]},"resetYear":{"type":"integer","format":"int32"},"tags":{"description":"List of <<glossary:data tag>> IDs to apply to this program.","type":"array","items":{"type":"string"}},"status":{"description":"Status of this program.","type":"string","enum":["Draft","Finalized"]},"notes":{"type":"string","description":"Notes regarding this program."},"templateName":{"description":"Name of contract template that defines program.","type":"string"},"currencyCode":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s of the treaty. For example, _USD_."},"quoteStatus":{"description":"Current stage of the program's underwriting process.","type":"string"},"defaultStartDate":{"description":"Default start date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"defaultEndDate":{"description":"Default end date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"organization":{"description":"Details about the organization attached to this program.","$ref":"#/components/schemas/ProgramOrganization"},"brokerage":{"type":"number","description":"Amount paid to a reinsurer to participate in this program"},"otherVariableExpense":{"type":"number","description":"Other expenses, e.g. legal fees."},"customProgramLabel1":{"description":"Custom metadata for program, business hierarchy, or program treaty. ","type":"string"},"customProgramLabel2":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"customProgramLabel3":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"customProgramLabel4":{"type":"string","description":"Custom metadata for program, business hierarchy, or program treaty. "},"programSetSummary":{"$ref":"#/components/schemas/ProgramSetSummary"},"businessHierarchySetSummary":{"$ref":"#/components/schemas/BusinessHierarchySetSummary"},"isPrime":{"type":"boolean","default":"false","description":"If `true` this is the main program between the insurer and cedant.","nullable":true},"treatiesCount":{"type":"number","readOnly":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"createdAt":{"type":"string","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company.com` for federated tenants. Login strings are lowercase. See [Logins](ref:principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","readOnly":true},"materialModifiedAt":{"type":"string","format":"date-time","readOnly":true}}},"ProgramBase":{"type":"object","allOf":[{"type":"object","$ref":"#/components/schemas/ProgramSummary"},{"type":"object","properties":{"riskBlocks":{"type":"array","description":"List of <<glossary:risk block>>s covered by this program.","items":{"$ref":"#/components/schemas/RiskBlock"}},"treaties":{"description":"List of program treaties (retrocession treaties) attached to this program.","type":"array","items":{"$ref":"#/components/schemas/ProgramTreaty"}},"displayColumns":{"type":"array","items":{"$ref":"#/components/schemas/DisplayColumn"}}}}]},"ProgramBaseSaveAsNew":{"type":"object","allOf":[{"type":"object","$ref":"#/components/schemas/ProgramSummarySaveAsNew"},{"type":"object","properties":{"riskBlocks":{"type":"array","description":"List of <<glossary:risk block>>s covered by this program.","items":{"$ref":"#/components/schemas/RiskBlock"}},"treaties":{"description":"List of program treaties (retrocession treaties) attached to this program.","type":"array","items":{"$ref":"#/components/schemas/ProgramTreaty"}},"displayColumns":{"type":"array","items":{"$ref":"#/components/schemas/DisplayColumn"}}}}]},"Program":{"required":["name","programSetId","source"],"allOf":[{"type":"object","$ref":"#/components/schemas/ProgramBase"},{"type":"object","properties":{"primeAnalysisId":{"type":"integer","format":"int64"},"riskSources":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProgramRiskSource"}},"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/ProgramCoordinate"}}}}]},"ProgramSaveAsNew":{"required":["programName"],"allOf":[{"type":"object","$ref":"#/components/schemas/ProgramBaseSaveAsNew"},{"type":"object","properties":{"primeAnalysisId":{"type":"integer","format":"int64"},"riskSources":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ProgramRiskSource"}},"coordinates":{"type":"array","items":{"$ref":"#/components/schemas/ProgramCoordinate"}}}}]},"ProgramCoordinate":{"required":["uuid","x","y"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}}},"ProgramTreaty":{"type":"object","properties":{"treatyUuid":{"description":"UUID of this program treaty.","type":"string","format":"uuid"},"treatyName":{"description":"Name of this program treaty (retrocession treaty). Must be unique within program.","type":"string"},"treatyNumber":{"type":"string","description":"User-defined ID of this program treaty (contract)."},"status":{"description":"Status of this program treaty.","type":"string","default":"New","enum":["AtRisk","Cancelled","Defaulted","Extended","Impaired","New","OffRisk","Offered","OnRisk","Quote","Signed","Written"]},"termCurrencyCode":{"description":"Two-letter [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) country code that identfies the default currency this program treaty’s terms. For example, _USD_.","type":"string"},"templateCode":{"description":"Contract template that defines this program treaty.","type":"string","enum":["Aggregate XoL","Aggregate XoL with Occurrence Terms","Florida Hurricane Cat Fund","Occurrence XoL","Quota Share","XoL with Reinstatements"]},"riskStartDate":{"type":"string","description":"Effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"date"},"riskEndDate":{"description":"Expiration date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date"},"subjects":{"description":"List of subjects (exposures and risk sources) that are subject to terms of this program treaty.","type":"array","items":{"$ref":"#/components/schemas/SubjectOfLoss"}},"isin":{"description":"ISIN number (International Securities Identification Number), e.g. `US38259P5089`","type":"string","example":"US38259P5089"},"totalAmount":{"type":"number","description":"The final amount a reinsurer is offerring to participate in the program treaty.","format":"double"},"canParticipate":{"type":"boolean","description":"Participation option. If `true`, the reinsurer can participate in the program treaty."},"signedLine":{"description":"Final amount the reinsurer is obligated to participate in a reinsurance contract. May be less than the written share.","$ref":"#/components/schemas/BigDecimal"},"attributes":{"description":"Terms of this program treaty. Includes expense terms, placement terms, occurrence terms, reinstatment terms, and subterms","$ref":"#/components/schemas/TreatyAttribute"},"reference":{"description":"Label that identifies this program treaty in external systems of record.","type":"string"},"metadata":{"type":"array","description":"Custom metadata used to identify program.\n\nDefined as either text fields or dropdown lists populated by options. TreatyIQ allows a maximum of 25 custom fields at the program and treaty level.","items":{"$ref":"#/components/schemas/MetadataItem"}}}},"MetadataItem":{"required":["uuid","value"],"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the <<glossary:rollup metadata>> record.","format":"uuid","example":"632d0285-a7c5-469c-a037-191c88341d58"},"value":{"type":"string","description":"Type of rollup metadata record, e.g. `PROGRAM` (<<glossary:primary insurance program>>), `PROGRAM` (<<glossary:reinsurance program>>), `TREATY` (<<glossary:program treaty>>).","enum":["PORTFOLIO","PROGRAM","TREATY"]}}},"ProgramOrganization":{"type":"object","properties":{"broker":{"type":"string","description":"Name of broker"},"legalEntity":{"type":"string","description":"Legal name of entity"},"businessUnit":{"type":"string","description":"Business unit"},"office":{"type":"string","description":"Office"}}},"RiskBlock":{"required":["isReported","name","riskEndDate","riskStartDate","termCurrencyCode","RiskBlockUuid"],"type":"object","properties":{"riskBlockUuid":{"type":"string","description":"UUID of <<glossary:risk block>>.","format":"uuid"},"riskBlockName":{"type":"string","description":"Name of <<glossary:risk block>>."},"termCurrencyCode":{"type":"string","description":"Currency code of contract"},"riskStartDate":{"type":"string","description":"Inception date. From this date losses are potentially eligible for recovery. Default value for every treaty added to this program","format":"date"},"riskEndDate":{"type":"string","description":"Expiration date. From this date a loss-occuring treaty no longer takes loss and risk-attaching treaty no longer allows risk to attach. Default value for every treaty added to this program","format":"date"},"subjects":{"type":"array","items":{"$ref":"#/components/schemas/SubjectOfLoss"}},"reference":{"type":"string","description":"Label that identifies this program treaty in external systems of record."},"isReported":{"type":"boolean"}}},"BigDecimal":{"type":"object","properties":{"bigDecimal":{"type":"number"},"mc":{"required":["precision","roundingMode"],"type":"object","properties":{"precision":{"type":"integer","format":"int32"},"roundingMode":{"type":"string","enum":["UP","DOWN","CEILING","FLOOR","HALF_UP","HALF_DOWN","HALF_EVEN","UNNECESSARY"]}}}}},"RiskSourceLinkAnalysesRequest":{"required":["perspectiveCode","riskAnalysisId"],"type":"object","properties":{"riskAnalysisId":{"type":"integer","format":"int64"},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  "},"name":{"type":"string"},"description":{"type":"string"},"segments":{"type":"array","items":{"type":"string","enum":["country","admin1"]}},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int32"}},"addCedantExposure":{"type":"boolean","default":false},"extendDates":{"type":"boolean","default":false}}},"RiskSourceLinkAnalysesResponse":{"required":["uuid"],"type":"object","properties":{"riskSourceUuid":{"type":"string","format":"uuid"},"riskAnalysisId":{"type":"integer","format":"int64"},"perspectiveCode":{"type":"string"},"segments":{"type":"array","items":{"type":"string","enum":["country","admin1"]}},"portfolioId":{"type":"object"},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int32"}}}},"ErrorMessageWithDetails":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"},"details":{"type":"array","nullable":true,"items":{"type":"object","properties":{"field":{"type":"string"},"messages":{"type":"array","nullable":true,"items":{"type":"string"}}}}}}},"SummaryReportRequest":{"required":["reportType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific account or porfolio.","example":"/platform/riskdata/v1/exposures/1/accounts/1"},"resourceType":{"type":"string","description":"Type of resource.","enum":["account","analysis","portfolio"]},"reportType":{"description":"Type of report.","type":"string","enum":["ANALYSIS_SUMMARY","EXPOSURE_SUMMARY"]},"settings":{"description":"Report-specific configuration settings.","$ref":"#/components/schemas/SummaryReportSettings"}}},"PortfolioAccountResponse":{"type":"array","items":{"$ref":"#/components/schemas/AccountInfo"}},"AccountInfo":{"type":"object","properties":{"accountId":{"type":"integer"},"accountName":{"type":"string"},"accountNumber":{"type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"underwriter":{"$ref":"#/components/schemas/UnderwriterInfo"},"branch":{"$ref":"#/components/schemas/BranchInfo"},"userId1":{"type":"string"},"userId2":{"type":"string"},"userId3":{"type":"string"},"userId4":{"type":"string"},"userText1":{"type":"string"},"userText2":{"type":"string"},"createDate":{"type":"string","format":"date-time"},"stampDate":{"type":"string","format":"date-time"},"isValid":{"type":"boolean"},"uri":{"type":"string"},"locationsCount":{"type":"integer"},"geocodeVersion":{"type":"string"},"hazardVersion":{"type":"string"},"ownerName":{"type":"string"},"resultsCount":{"type":"integer"},"policyExpirationDate":{"type":"string","format":"date-time"},"policyExpirationStatus":{"type":"string"},"totalTIV":{"type":"number","format":"float"},"reportsCount":{"type":"integer"},"tagIds":{"type":"array","items":{"type":"integer"}}}},"AccountAccumulationDetailsRequest":{"required":["reportType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific analysis.","example":"/platform/riskdata/v1/analyses/5555"},"resourceType":{"type":"string","description":"Type of resource.","enum":["account"]},"reportType":{"description":"Type of report.","type":"string","enum":["ACCOUNT_ACCUMULATION_DETAILS"]},"settings":{"description":"Report-specific configuration settings.","$ref":"#/components/schemas/AccountAccumulationDetailsSettings"}}},"PortfolioAccumulationDetailsRequest":{"required":["reportType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific analysis.","example":"/platform/riskdata/v1/analyses/5555"},"resourceType":{"type":"string","description":"Type of resource.","enum":["analysis"]},"reportType":{"description":"Type of report.","type":"string","enum":["PORTFOLIO_ACCUMULATION_DETAILS"]},"settings":{"description":"Report-specific configuration settings.","$ref":"#/components/schemas/PortfolioAccumulationDetailsSettings"}}},"BusinessHierarchyAccumulationDetailsRequest":{"required":["reportType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific analysis.","example":"/platform/riskdata/v1/analyses/5555"},"resourceType":{"type":"string","description":"Type of resource.","enum":["analysis"]},"reportType":{"description":"Type of report.","type":"string","enum":["BUSINESS_HEIRARCHY_ACCUMULATION_DETAILS"]},"settings":{"description":"Report-specific configuration settings.","$ref":"#/components/schemas/BusinessHeirarchyAccumulationDetailsSettings"}}},"ExposureDoiReportRequest":{"required":["reportType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"description":"URI of resource instance, e.g. a specific portfolio.","example":"/platform/riskdata/v1/exposures/5555/portfolios/5555","type":"string"},"resourceType":{"type":"string","description":"Type of resource.","enum":["portfolio"]},"reportType":{"type":"string","description":"Type of report.","enum":["EXPOSURE_DOI_REPORT"]},"settings":{"description":"Report-specific configuration settings.","$ref":"#/components/schemas/ExposureDoiReportSettings"}}},"ExposureDoiReportSettings":{"required":["fileExtension","perilCodes","reportName"],"type":"object","properties":{"reportName":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string","description":"Name of report.\n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters."},"perilCodes":{"description":"Peril covered in report. `EQ` (Earthquake) is the only valid value.","maxItems":1,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"string","enum":["eq"]}},"fileExtension":{"description":"File extension of risk data report, e.g. `PDF`.","type":"string","enum":["PDF"]},"scaleFactors":{"type":"array","description":"List of scale factors used to adjust building value to account for replacement cost increases.","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of scale factor.","enum":["building","content","bi"]},"factor":{"description":"Value of scale factor. Default value of _1.00_  does not adjust the building value.","type":"number","format":"float","example":1}}}},"additionalDownloadOptions":{"type":"object","description":"Options for exporting to <<glossary:RDM>> on <<glossary:Data Bridge>> or downloading report as database artifact.","properties":{"rdmDatabridge":{"type":"object","description":"Configuration for exporting DOI data to RDM on Data Bridge.","properties":{"serverId":{"type":"integer","format":"int64","description":"ID of server instance."},"rdmName":{"maxLength":80,"minLength":0,"pattern":"^$|^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string","description":"Name of RDM. \n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters."},"databaseId":{"type":"integer","format":"int64","description":"ID of database."}}},"rdm":{"required":["rdmName","sqlVersion"],"type":"object","description":"Configuration for downloading DOI data as RDM <<glossary:database artifact>>.","properties":{"rdmName":{"maxLength":80,"minLength":0,"pattern":"^$|^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string","description":"Name of RDM.\n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters."},"sqlVersion":{"type":"string","description":"SQL server version of exported BAK or MDF database artifact.","example":"2019","enum":["2019","2014","2016"]},"fileExtension":{"type":"string","description":"File extension of database artifact.","example":"BAK","enum":["BAK","MDF"]}}}}}}},"SummaryReportSettings":{"required":["fileExtension","perilCodes","reportName"],"type":"object","properties":{"reportName":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string","description":"Name of report.\n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters."},"customBands":{"type":"array","description":"List of bands that define intervals for aggregating hazard-specific data in the report. Each band is defined by a <<glossary:hazard>> and a number of band intervals that specify the range of values within each band. ","items":{"$ref":"#/components/schemas/CustomBand"}},"perilCodes":{"description":"Peril covered in report. One of: `CS/WT` (Severe Convective Storm and Winterstorm), `EQ` (Earthquake), `FL` (Flood), `FR` (Fire), `TR` (Terrorism), `WC` (Workers Compensation), `WS` (Windstorm).","maxItems":1,"minItems":1,"uniqueItems":true,"type":"array","items":{"type":"string","enum":["cs/wt","eq","fl","fr","tr","wc","ws"]}},"fileExtension":{"type":"string","description":"File extension of risk data report.","enum":["JSON","PDF"]},"currency":{"type":"object","description":"Currency used in modeling of exposure variation.","properties":{"currencySchemeName":{"type":"string","description":"Name of currency scheme.","example":"RMS"},"currencyCode":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencyVintageName":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"RL25"}}}}},"AccountAccumulationDetailsSettings":{"required":["fileExtension","data"],"type":"object","properties":{"fileExtension":{"description":"File extension of risk data report.","type":"string","enum":["CSV"]},"fileName":{"description":"Name of risk data report.","type":"string"},"data":{"type":"array","description":"List of summary-level data to export: One or more of `Accounts`, `Events`, `Geographies`, `Locations`, `Policies`.  Each type is exported to separate file.","items":{"type":"string","uniqueItems":true,"nullable":false,"minItems":1,"enum":["Events","Geographies","Locations","Policies"]}}}},"PortfolioAccumulationDetailsSettings":{"required":["fileExtension","data"],"type":"object","properties":{"fileExtension":{"description":"File extension of risk data report.","type":"string","enum":["CSV"]},"fileName":{"description":"Name of risk data report.","type":"string"},"eventId":{"description":"ID of event in multi-event accumulation.","type":"number","format":"int64"},"data":{"type":"array","description":"List of summary-level data to export: One or more of `Accounts`, `Events`, `Geographies`, `Locations`, `Policies`.  Each type is exported to separate file.","items":{"type":"string","uniqueItems":true,"nullable":false,"minItems":1,"enum":["Accounts","Events","Geographies","Locations","Policies"]}}}},"BusinessHeirarchyAccumulationDetailsSettings":{"required":["fileExtension","data"],"type":"object","properties":{"fileExtension":{"description":"File extension of risk data report.","type":"string","enum":["CSV"]},"fileName":{"type":"string","description":"Name of file."},"eventId":{"type":"number","description":"ID of event in multi-event accumulation.","format":"int64"},"data":{"type":"array","description":"List of summary-level data to export: One or more of `Accounts`, `BusinessHierarchy`, `Portfolios`, `Programs`, `Treaties`, `TreatySubjects`. Each type is exported to separate file.","items":{"type":"string","uniqueItems":true,"nullable":false,"minItems":1,"enum":["Accounts","BusinessHierarchy","Portfolios","Programs","Treaties","TreatySubjects"]}}}},"Band":{"required":["greaterThanOrEqualTo"],"type":"object","properties":{"greaterThanOrEqualTo":{"description":"Lower limit of band interval.","minimum":0,"type":"number","format":"double"},"lessThan":{"description":"Upper limit of band interval.","maximum":10000,"type":"number","format":"double"}}},"CustomBand":{"required":["hazard"],"type":"object","properties":{"hazard":{"type":"string","description":"Dimension of hazard data to be banded. \n\nHazard data is peril-specific. Ensure that the hazard value is appropriate for the specified `perilCodes`. To learn more, see [Hazard Lookup Options](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/GeoHaz.htm#HazardLookupOptions) in Help Center."},"bands":{"maxItems":10,"minItems":1,"type":"array","description":"List of bands. Each band defines a range of values for aggregating  hazard-specific data. ","items":{"$ref":"#/components/schemas/Band"}}}},"ProgramSet":{"type":"object","required":["programSetName"],"properties":{"programSetName":{"type":"string","description":"Name of program set. Cannot contain special characters other than `-` (hyphen), `_` (underscore), `&` (ampersand), (`(`, `)`) braces."},"programSetId":{"description":"ID of this program set.","type":"integer","format":"int64","readOnly":true},"uri":{"type":"string","description":"Resource URI of this program set. See [Resource URI](doc:resource-uris).","format":"uri","readOnly":true},"uuid":{"type":"string","description":"System-defined UUID of this program set, e.g. _2408e398-ed5e-49e3-a44b-e52b7c3f564b_","format":"uuid","readOnly":true},"owner":{"type":"string","readOnly":true},"groups":{"type":"array","description":"List of groups that can access child business hierarchies and <<glossary:outward program>>s.","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","readOnly":true}}}},"cedenceType":{"type":"string","description":"Type of cedence. One of `Inward`, `Outward`"},"cedant":{"type":"string","description":"Name of risk-holding party (insurer/reinsured) that transfers a portion of its risk to another risk-holding party (reinsurer/retrocessionaire)"},"underwriter":{"type":"string","format":"email","description":"Login of <<glossary:treaty underwriter>> associated with this business hierarchy. ","example":"user.name@company.com"},"reference":{"type":"string","description":"Label that identifies this program treaty in external systems of record."},"createdBy":{"type":"string","description":"Login of <<glossary:principal>> that created business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","readOnly":true},"createdAt":{"type":"string","description":"Date this business hierarchy set was created in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"description":"Date this business hierarchy set was modified in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","type":"string","format":"date-time","readOnly":true},"primeProgramId":{"type":"integer","description":"ID of prime program in this program set.","format":"int64","nullable":true,"readOnly":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true}}},"PatchProgramSetRequest":{"oneOf":[{"type":"object","properties":{"operation":{"type":"string","enum":["UPDATE"]},"targetProperty":{"type":"string","enum":["programSetName","primeProgramId","cedenceType","cedant","underwriter","reference"]},"value":{"type":"string"}}},{"type":"object","properties":{"operation":{"type":"string","enum":["ADD","REMOVE"]},"targetProperty":{"type":"string","enum":["groupId"]},"value":{"type":"string","format":"uuid"}}}]},"BusinessHierarchySet":{"type":"object","required":["businessHierarchySetName"],"properties":{"businessHierarchySetName":{"description":"Name of this business hierarchy set.","type":"string"},"businessHierarchySetId":{"type":"integer","description":"User-defined ID of this business hierarchy set.","format":"int64","readOnly":true},"description":{"type":"string"},"uri":{"type":"string","description":"Resource URI of this business hierarchy set. See [Resource URIs](doc:resource-uris)","format":"uri","readOnly":true},"uuid":{"type":"string","format":"uuid","description":"System-defined UUID of this business hierarchy set.","readOnly":true},"owner":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that owns business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"businessOwner":{"type":"string"},"primeBusinessHierarchyId":{"description":"ID of primary business hierarchy in this set.","type":"integer","format":"int64","nullable":true,"readOnly":true},"groups":{"type":"array","description":"List of groups that can access child business hierarchies and <<glossary:outward program>>s.","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","readOnly":true}}}},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"createdAt":{"type":"string","description":"Date this business hierarchy was created in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"date-time","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated business hierarchy set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"description":"Date this business hierarchy was created in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date-time","readOnly":true},"thumbPrint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20260212.66","readOnly":true}}},"PatchBusinessHierarchySetRequest":{"oneOf":[{"type":"object","properties":{"operation":{"type":"string","enum":["UPDATE"]},"targetProperty":{"type":"string","enum":["businessHierarchySetName","businessOwner","description","primeBusinessHierarchyId"]},"value":{"type":"string"}}},{"type":"object","properties":{"operation":{"type":"string","enum":["ADD","REMOVE"]},"targetProperty":{"type":"string","enum":["groupId"]},"value":{"type":"string","format":"uuid"}}}]},"Details":{"type":"object","properties":{"resources":{"type":"array","items":{"$ref":"#/components/schemas/Uri"}},"summary":{"type":"string"},"log":{"type":"object","description":"For `MOVE_DATABASE` jobs, provides database move details.","properties":{"sourceServerName":{"type":"string","description":"Name of the source database server."},"destinationServerName":{"type":"string","description":"Name of the destination database server."},"databaseType":{"type":"string","description":"Type of the database, e.g. `EDM`, `RDM`."},"databaseName":{"type":"string","description":"Name of the database."},"edmName":{"type":"string","description":"Name of the exposure data module."}}}}},"JobDetailResponse":{"type":"object","properties":{"jobId":{"type":"string","description":"ID of risk data job."},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"status":{"type":"string","description":"Status of risk data job.","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"description":"Date risk data job was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z","type":"string"},"startedAt":{"type":"string","description":"Date risk data job was started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"endedAt":{"type":"string","description":"Date risk data job ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"name":{"type":"string"},"type":{"type":"string"},"progress":{"type":"integer","description":"Progress of risk data job.","format":"int32"},"priority":{"type":"string","description":"Priority of risk data job."},"entitlement":{"type":"string","description":"Licensed Intelligent Risk Platform program. One of `RI-EXPOSUREIQ`, `RI-RISKMODELER`, `RI-TREATYIQ`, `UNDERWRITEIQ`","example":"RI-RISKMODELER"},"resourceGroupId":{"type":"string","description":"ID of <<glossary:resource group>> to which job is allocated."},"details":{"$ref":"#/components/schemas/Details"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/TaskWarnMessage"}},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}},"Task":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of task."},"guid":{"type":"string","format":"uuid","description":"Unique ID of task."},"jobId":{"type":"string","description":"ID of parent job."},"status":{"type":"string","description":"Status of task."},"submittedAt":{"type":"string","description":"Date task was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"createdAt":{"type":"string","description":"Date task was initiated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"name":{"type":"string","description":"Name of task."},"percentComplete":{"type":"integer","description":"Percent of completion for task.","format":"int32"},"priorTaskGuids":{"type":"array","description":"List of tasks in job.","items":{"type":"string","format":"uuid"}},"output":{"$ref":"#/components/schemas/TaskOutput"}}},"TaskErrorMessage":{"type":"object","properties":{"message":{"type":"string"}}},"TaskOutput":{"type":"object","properties":{"summary":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/TaskErrorMessage"}},"log":{"type":"object","additionalProperties":{"type":"string"}}}},"TaskWarnMessage":{"type":"object","properties":{"message":{"type":"string"}}},"Uri":{"type":"object","properties":{"uri":{"type":"string"}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"},"details":{"type":"array","nullable":true,"items":{"type":"object","properties":{"field":{"type":"string"},"messages":{"type":"array","nullable":true,"items":{"type":"string"}}}}}}},"JobResponse":{"type":"object","properties":{"jobId":{"type":"string"},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string"},"startedAt":{"type":"string"},"endedAt":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"progress":{"type":"integer","format":"int32"},"priority":{"type":"string"},"entitlement":{"type":"string","description":"Licensed Intelligent Risk Platform program. One of `RI-EXPOSUREIQ`, `RI-RISKMODELER`, `RI-TREATYIQ`, `UNDERWRITEIQ`","example":"RI-RISKMODELER"},"resourceGroupId":{"type":"string","description":"ID of <<glossary:resource group>> to which job is allocated."},"details":{"$ref":"#/components/schemas/Details"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/TaskWarnMessage"}}}},"GeoHaz":{"required":["resourceType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific account or porfolio.","example":"/platform/riskdata/v1/exposures/1/portfolios/1"},"resourceType":{"type":"string","enum":["portfolio","account"]},"settings":{"$ref":"#/components/schemas/GeoHazSettings"}}},"GeoHazSettings":{"required":["layers"],"type":"object","properties":{"layers":{"type":"array","items":{"$ref":"#/components/schemas/LayerInfo"}}}},"LayerInfo":{"type":"object","description":"Options that apply to the layer. Different parameter are required depending on the `type`:\n\n  - If `geocode`, `aggregateTriggerEnabled`, `geoLicenseType`, and `skipPrevGeocoded` are required.\n  - If `hazard`, `overrideUserDef` and `skipPrevHazard` are required. ","properties":{"type":{"type":"string","description":"Type of job. One of `geocode` or `hazard`.\n\n- `geocode` type supports geocoding using either `RL` or `HD` engine.\n- `hazard` type supports hazard lookups (`RL` or `HD` engine) and variety of enhanced risk data lookups including risk scores for different perils (`HD` engine).","example":"hazard","enum":["geocode","hazard"]},"engineType":{"description":"Type of engine used to enrich location. One of `RL` (DLM) or `HD` (High Definition).\n\n- If `RL`, layer enriches location for DLM model. Supports geocoding and hazard lookups.\n- If `HD`, layer enriches location for HD model. Supports geocoding, hazard lookups, and enhanced risk data.","type":"string","enum":["HD","RL"]},"name":{"type":"string","description":"Name of layer (data product).\n\nLayer options depend on `type` and `engine`.\n\n|Type|Engine|Supported Layers|\n|----|-----|----|\n|`geocode`|`RL`|`geocode`|\n|`geocode`|`HD`|`geocode`|\n|`hazard`|`RL`|`earthquake`, `windstorm`|\n|`hazard`|`HD`| `cs_risk_score`, `distance_to_fault`,  `distance_to_fire_station`,`distance_to_inner_coast`, `eq_risk_score`, `esdb_building_attributes`, `fema_firm`, `fl_depth`, `fl_hazard`, `fl_risk_score`, `global_fl_depth`, `hd_earthquake`, `mmi`, `subsidence `, `surge `,  `tr_risk_score`, `wf_model_hazard`, `wf_risk_score`, `wf_supplemental_hazard`, `ws_model_hazard`, `ws_risk_score `, `ws_windpool_zone`, `wt_risk_score`|","enum":["cs_risk_score","distance_to_fault","distance_to_fire_station","distance_to_inner_coast","earthquake","eq_risk_score","esdb_building_attributes","fema_firm","fl_depth","fl_hazard","fl_risk_score","geocode","global_fl_depth","hd_earthquake","mmi","subsidence","surge","tr_risk_score","wf_model_hazard","wf_risk_score","wf_supplemental_hazard","windstorm","ws_model_hazard","ws_risk_score","ws_windpool_zone","wt_risk_score"]},"version":{"type":"string","description":"Version of layer (data product) supported.  \n\nValid versions depend on specified `name`, `type`, and `engine` values. ","enum":["18.0","18.1","21.0","22.0","23.0","24.0","25.0","1.0","1.1","1.2","1.3","2.0","3.0","latest"]},"layerOptions":{"$ref":"#/components/schemas/LayerOptions"}},"required":["engineType","name","type","version"]},"LayerOptions":{"type":"object","description":"Options that apply to the layer. For example `aggregateTriggerEnabled`, `geoLicenseType`, `overrideUserDef`, `skipPrevGeocoded`, `skipPrevHazard`.\n","properties":{"aggregateTriggerEnabled":{"type":"boolean","description":"If `true`, latitude and longitude coordinates are set to 0.0 at coarser geocoding resolutions (e.g. country, state, or CRESTA) in some modeled countries. Applies to DLM models only. Required if `type` is `geocode`.\n","default":false},"geoLicenseType":{"type":"string","description":"Type of geocoding license. One of `0` (Risk Modeler), or `1` (ExposureIQ). Required if `type` is `geocoding`.\n","enum":[0,1],"default":0},"skipPrevGeocoded":{"type":"boolean","description":"`RL` only. If `true`, previously geocoded locations are not geocoded. Required if `type` is `geocode`.","default":false},"overrideUserDef":{"type":"boolean","description":"If `true`, user-defined settings are overridden. Required if `type` is `hazard`.","default":false},"skipPrevHazard":{"type":"boolean","description":"If `true`, no lookup of hazard data if hazard data has been looked up previously for the location. Required if `type` is `hazard`.","default":false}}},"PatchJobRequest":{"type":"object","properties":{"status":{"type":"string","description":"Status of risk data job.","enum":["CANCELLED"]},"priority":{"type":"string","description":"Priority of risk data job.","enum":["veryhigh","high","medium","low","verylow"]}}},"Currency":{"required":["asOfDate","code","scheme","vintage"],"type":"object","properties":{"code":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"scheme":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"asOfDate":{"type":"string","description":"Effective date of currency scheme in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`.","example":"2020-01-01T00:00:00.000Z"},"vintage":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`)."}}},"AnalysisGroupSettings":{"required":["analysisName","currency","numOfSimulations","propagateDetailedLosses","simulateToPLT"],"type":"object","properties":{"forceGroupType":{"type":"string"},"reportingWindowStart":{"maxLength":2147483647,"minLength":1,"type":"string"},"numOfSimulations":{"type":"integer","format":"int64"},"simulationWindowStart":{"maxLength":2147483647,"minLength":1,"type":"string"},"simulationWindowEnd":{"maxLength":2147483647,"minLength":1,"type":"string"},"simulateToPLT":{"type":"boolean"},"propagateDetailedLosses":{"type":"boolean"},"regionPerilSimulationSet":{"type":"array","items":{"$ref":"#/components/schemas/RegionPerilSimulation"}},"analysisName":{"maxLength":64,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string","description":"Name of analysis result. Valid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters.\n"},"description":{"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"}}},"CreateAnalysisGroup":{"required":["resourceType","resourceUris","settings"],"type":"object","properties":{"resourceType":{"type":"string","enum":["analyses"]},"resourceUris":{"type":"array","items":{"type":"string"}},"settings":{"$ref":"#/components/schemas/AnalysisGroupSettings"}}},"RegionPerilSimulation":{"required":["simulationPeriods","simulationSetId"],"type":"object","properties":{"perilCode":{"type":"string","description":"ID of peril."},"modelVersion":{"type":"string","description":"Version of model. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)"},"eventRateSchemeId":{"type":"integer","description":"ID of the <<glossary:event rate scheme>> to use to compute the PLT. ","format":"int32"},"regionCode":{"type":"string","description":"Two letter code of region analyzed, e.g. `AU`, `CB`, `AC`, `CC`. See [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)"},"simulationSetId":{"type":"integer","description":"ID of period event quantile table (PEQT).","format":"int64","example":70},"simulationPeriods":{"type":"integer","format":"int64","description":"Number of <<glossary:simulation periods>> used to compute PLT."},"modelRegionCode":{"type":"string","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril. See [Moody's Peril Models List for Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/Reference/Peril_Models_List.htm)"},"eltAnalysisId":{"type":"integer","format":"int64"},"engineVersion":{"type":"string","description":"Version of model engine used in model profile. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL13","RL13.1","RL15","RL16","RL17","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24","PLTALM1.0","PLTGroup1.0","Unrecognized"]}}},"AlmModelSettings":{"required":["almProfileIds","currency"],"type":"object","allOf":[{"$ref":"#/components/schemas/ModelJobSettings"},{"type":"object","properties":{"almProfileIds":{"type":"array","items":{"type":"integer","format":"int32"}},"analysisMode":{"type":"string"},"portEltByGeoidByLobByCedant":{"type":"boolean"},"portStatsByGeoidByLobByCedant":{"type":"boolean"},"portStatsByGeoidByCedant":{"type":"boolean"}}}]},"DlmModelSettings":{"required":["currency","franchiseDeductible","minLossThreshold","numMaxLossEvent","treatConstructionOccupancyAsUnknown"],"type":"object","allOf":[{"$ref":"#/components/schemas/ModelJobSettings"},{"type":"object","properties":{"eventRateSchemeId":{"type":"integer","format":"int32","description":"ID of the <<glossary:event rate scheme>> to use to compute the PLT. "},"modelProfileId":{"type":"integer","format":"int32"},"outputProfileId":{"type":"integer","format":"int32"},"climateChangeVariationId":{"maximum":68,"minimum":0,"type":"integer","format":"int32"},"franchiseDeductible":{"type":"boolean"},"minLossThreshold":{"minimum":0,"exclusiveMinimum":false,"type":"number","format":"double"},"treatConstructionOccupancyAsUnknown":{"type":"boolean"},"numMaxLossEvent":{"maximum":5000,"minimum":1,"type":"integer","format":"int32"}}}]},"Model":{"required":["resourceType","resourceUri","settings","type"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of resource instance, e.g. a specific account or porfolio.","example":"/platform/riskdata/v1/exposures/1/portfolio/1"},"resourceType":{"type":"string","enum":["portfolio","account","aggportfolio"]},"type":{"type":"string","description":"model type","example":"One of ALM or DLM or HD"},"settings":{"$ref":"#/components/schemas/ModelJobSettings"}}},"ModelJobSettings":{"required":["currency","type"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"treatyIds":{"type":"array","description":"List of treaties.","items":{"type":"integer","format":"int32"}},"name":{"maxLength":64,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string"},"tagIds":{"type":"array","description":"List of tags to apply to this job. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}},"type":{"type":"string"}},"discriminator":{"propertyName":"type","mapping":{"DLM":"#/components/schemas/DlmModelSettings","HD":"#/components/schemas/DlmModelSettings","ALM":"#/components/schemas/AlmModelSettings"}}},"Account":{"required":["accountNumber"],"type":"object","properties":{"accountId":{"description":"User-defined ID of account.","type":"integer","format":"int32","readOnly":true},"accountName":{"description":"User-defined name of account. Required if you want to append imported locations to this account.\n","type":"string"},"accountNumber":{"type":"string","description":"Unique ID number for account."},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"underwriter":{"$ref":"#/components/schemas/UnderwriterInfo"},"branch":{"$ref":"#/components/schemas/BranchInfo"},"userId1":{"type":"string","description":"User-defined account property."},"userId2":{"type":"string","description":"User-defined account property."},"userId3":{"type":"string","description":"User-defined account property."},"userId4":{"type":"string","description":"User-defined account property."},"userText1":{"type":"string","description":"User-defined note."},"userText2":{"type":"string","description":"User-defined note."},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"stampDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true},"tagIds":{"type":"array","description":"List of tags to apply to this account. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"BranchInfo":{"required":["branchId","branchName"],"type":"object","description":"Branch that underwrites the account.\n","properties":{"branchId":{"minimum":1,"type":"integer","format":"int32","description":"ID of branch.","example":22},"branchName":{"maxLength":30,"minLength":0,"type":"string","description":"Name of branch.","example":"London"}}},"CedantInfo":{"required":["cedantId","cedantName"],"description":"Risk-holding party (insurer/reinsurer) that is transferring a portion of risk to another risk-holding party (reinsurer/retrocessionaire).\n","type":"object","properties":{"cedantId":{"description":"ID of cedant.","maxLength":20,"minLength":0,"pattern":"^\\w([\\w-]*\\w|)$","type":"string","example":"22"},"cedantName":{"description":"Name of cedant.","maxLength":40,"minLength":0,"type":"string","example":"CSW"}}},"ProducerInfo":{"required":["producerId","producerName"],"description":"Agent or brokerage that produced a policy.\n","type":"object","properties":{"producerId":{"description":"ID of producer.","maxLength":20,"minLength":0,"pattern":"^\\w([\\w-]*\\w|)$","type":"string","example":"3"},"producerName":{"description":"Name of producer.","maxLength":40,"minLength":1,"type":"string","example":"rena"}}},"UnderwriterInfo":{"required":["underwriterId","underwriterName"],"type":"object","description":"Risk-holding party that transfers risk to a cedant in exchange for some premium.\n","properties":{"underwriterId":{"minimum":1,"description":"ID of underwriter.","type":"integer","format":"int32","example":45},"underwriterName":{"description":"Name of underwriter.","maxLength":30,"minLength":0,"type":"string","example":"TSR"}}},"AccountMetrics":{"type":"object","properties":{"totalLocations":{"type":"integer","description":"Total number of locations.","example":4556,"format":"int32"},"totalPolicies":{"type":"integer","description":"Total number of policies.","example":15,"format":"int32"},"totalEmployees":{"type":"number","description":"Total number of employees.","example":3712217847,"format":"double"},"totalInsuredValue":{"$ref":"#/components/schemas/Amount"},"perilsExposed":{"type":"string","description":"Number of perils exposed.","example":"EQ, WS, FL, FR, TR, WI, Unknown"},"linkedAccount":{"$ref":"#/components/schemas/Account"},"linkedDatasource":{"type":"string"},"accountName":{"type":"string","description":"Name of account."},"accountNumber":{"type":"string","description":"Number of account."},"owner":{"type":"string"},"Underwriter":{"type":"string","description":"Name of <<glossary:underwriter>>."},"producer":{"type":"string","description":"Agent or brokerage that produced the policy."},"branch":{"type":"string","description":"Name of branch that underwrites the account."},"cedant":{"type":"string","description":"Name of risk-holding party (insurer/reinsurer) that transfers a portion of its risk to another risk-holding party (reinsurer/retrocessionaire)"},"geocodeVersion":{"type":"string","example":24,"description":"Version of geocoding."},"hazardVersion":{"type":"string","example":24,"description":"Version of hazard."},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"},"totalReports":{"type":"integer","description":"Number of <<glossary:report view>>s.","format":"int32","example":30}}},"Amount":{"type":"object","properties":{"value":{"type":"number","format":"double"},"currencyCode":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."}}},"AccountSearch":{"required":["accountNumber"],"type":"object","properties":{"accountId":{"description":"ID of account.","type":"integer","format":"int32","readOnly":true},"accountName":{"description":"Name of account.","type":"string"},"accountNumber":{"description":"Number of account.","type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"underwriter":{"$ref":"#/components/schemas/UnderwriterInfo"},"branch":{"$ref":"#/components/schemas/BranchInfo"},"userId1":{"type":"string","description":"User-defined account property."},"userId2":{"type":"string","description":"User-defined account property."},"userId3":{"type":"string","description":"User-defined account property."},"userId4":{"type":"string","description":"User-defined account property."},"userText1":{"type":"string","description":"User-defined note."},"userText2":{"type":"string","description":"User-defined note."},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"stampDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true},"locationsCount":{"description":"Number of locations.","type":"integer","format":"int32"},"geocodeVersion":{"type":"string"},"hazardVersion":{"type":"string","description":"List of hazard models run on account.\n"},"ownerName":{"type":"string","description":"Name of owner."},"resultsCount":{"type":"integer","format":"int32"},"policyExpirationDate":{"type":"string"},"policyExpirationStatus":{"type":"string","enum":["OPEN","EXPIRING_SOON","EXPIRED"]},"totalTIV":{"type":"number","description":"Sum of the insurable value across all location coverage values. For building and contents coverage, value equals replacement cost. For business interruption coverage, it equals value at one year of income. If the values differ by coverage, the TIV uses the highest value.","format":"double"},"reportsCount":{"description":"Number of reports.","type":"integer","format":"int32"},"tagIds":{"type":"array","description":"List of tags to applied to account.","items":{"type":"integer","format":"int32"}}}},"ExposureValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"}}},"CountryMetrics":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/ExposureValue"},"locationCount":{"type":"integer","format":"int32"}}},"LineOfBusinessInfo":{"required":["lobId","lobName"],"type":"object","properties":{"lobId":{"minimum":1,"type":"integer","format":"int32","description":"ID of line of business.","example":9},"lobName":{"maxLength":20,"minLength":0,"type":"string","description":"Name of line of business.","example":"FACTORY"},"uri":{"type":"string","readOnly":true,"description":"URI of line of business.","example":"/riskdata/v1/exposures/5/lobs/9"}}},"LossOccurrence":{"type":"object","properties":{"id":{"description":"System-generated ID of treaty.","type":"integer","format":"int32","readOnly":true},"treatyId":{"description":"ID of <<glossary:catastrophe treaty>>, <<glossary:corporate catastrophe treaty>>, or <<glossary:stop loss treaty>>.\n\nLoss occurrence record can be applied to catastrophe treaties. ","type":"integer","format":"int32"},"uri":{"type":"string","readOnly":true},"regionPeril":{"description":"Region-specific peril. For example, `APFL` (6), `EUCS` (2), `EUFL` (1), `EUWS` (7), `NAWF` (4), `NZFL` (5), `USFL` (3)\n\nFor a list of region peril codes, see [Moody's Peril Models List for Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/Reference/Peril_Models_List.htm) in Help Center.","$ref":"#/components/schemas/ExposureValue"},"lossOccurrenceTime":{"description":"Length of hours clause in days. Lost occurrence record limits the duration of liability. If _0_, `lossOccurrenceRadius` is ignored. \n\nApplicable if `regionPeril` is `APFL`, `EUCS`, `EUFL`, `EUWS`, `NZFL`, `USFL`, `USWF`.  ","type":"integer","format":"int32"},"lossOccurrenceRadius":{"description":"Radius of distance clause. Loss occurrence record limits the range of liability. If _0_, range of liability is unlimited or no distance clause is defined. \n\nApplicable if `regionPeril` is `USWF`. ","type":"integer","format":"int32"},"radiusUnit":{"description":"Unit of measurement used for `lossOccurrenceRadius` distance. One of `Miles` (1), or `Kilometers` (2).","$ref":"#/components/schemas/ExposureValue"},"multiLossOccurrence":{"description":"Indicates whether the treaty allows multiple loss occurrences for the same event. One of `Yes` (1) or `No` (2).","$ref":"#/components/schemas/ExposureValue"}}},"Treaty":{"required":["attachmentLevel","cedant","treatyNumber","treatyType"],"type":"object","properties":{"treatyId":{"readOnly":true,"description":"User-defined ID of treaty.","type":"integer","format":"int32","example":6},"treatyNumber":{"description":"Unique name of this treaty. Moody’s recommends using a combination of the cedant name, treaty type, and treaty terms.","maxLength":20,"minLength":0,"type":"string","example":"CID1-NCAT-20000"},"treatyName":{"description":"User-defined name of treaty","maxLength":40,"minLength":0,"type":"string","example":"CSW-CATA-90"},"cedant":{"description":"Name of risk-holding party (insurer/reinsurer) that transfers a portion of its risk to another risk-holding party (reinsurer/retrocessionaire). Cedant must match an account's cedant for all cessions and treaties to be applied during the analysis.\n","$ref":"#/components/schemas/CedantInfo"},"producer":{"description":"Name of party licensed under a state to sell, solicit, or negotiate insurance.\n","$ref":"#/components/schemas/ProducerInfo"},"treatyType":{"description":"Type of treaty.","type":"string","example":"CATA","enum":["CATA","CORP","NCAT","QUOT","STOP","SURP","WORK"]},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"attachmentBasis":{"type":"string","description":"Defines how insurance policies have their losses covered. If `L` (losses occurring), claims are covered that occur during the period of this treaty. If `R` (risks attaching), claims are covered if policy inception occurs during period of this treaty","example":"L","enum":["L","R"]},"attachmentLevel":{"description":"Level at which treaty is attached. One of `ACCT` (account), `LOC` (location), `POL` (policy), `PORT` (portfolio)","type":"string","example":"ACCT","enum":["ACCT","LOC","POL","PORT"]},"premium":{"description":"Amount insurer or reinsurer charges to provide the coverage described in the policy or treaty","type":"number","format":"double","example":20000},"occurrenceLimit":{"description":"Maximum amount paid out for an event.","type":"number","example":1000000,"format":"double"},"attachmentPoint":{"description":"Amount at which the occurrence layer begins to take loss.","type":"number","format":"double","example":220000},"riskLimit":{"description":"Maximum amount paid out for risk in an event. Applies to `QUOT` and `SURP` treaties.","type":"number","example":200000},"retentionAmount":{"description":"Amount of risk or loss kept by the ceding company for its own account or for others.","type":"number","example":150,"format":"double"},"percentagePlaced":{"description":"Percentage of a treaty’s coverage that has been accepted by participating reinsurers.","type":"number","format":"double","example":60},"effectiveDate":{"description":"Effective date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date losses are eligible for recovery.","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"description":"Expiration date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date a loss-occurring policy/treaty/program no longer takes loss and a risks-attaching policy/treaty/program no longer allows risks to attach.","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentageRetention":{"description":"Percentage of the reinsurer’s share of treaty losses not covered by retrocessions. Determines the losses for the `RN` financial perspective and the net premium a reinsurer receives for a treaty","type":"number","format":"double","example":0},"percentageRiShare":{"type":"number","description":"Percentage of treaty coverage assigned to reinsurer. Used in calculation of `RG` perspective losses.","format":"double","example":90},"percentageCovered":{"type":"number","description":"Percentage of loss greater than the attachment point covered by a treaty. Not applicable to `SURP` treaties.","format":"double","example":50},"priority":{"description":"Inurning priority of this treaty. Lower numbers take losses prior to higher numbers.","type":"integer","format":"int32","example":3},"numberOfReinstatements":{"type":"integer","description":"Number of reinstatements. Restoration of the treaty occurrence limit to its full amount after an event that led to a non-zero reinsurance payout so that the reinsured has the full limit coverage for the next event occurrence.\n\nUsed in calculating catastrophe and corporate catastrophe treaty statistics, including average annual loss. The event loss table and the EP curves assume unlimited reinstatements","format":"int32","example":99},"reinstatementCharge":{"type":"number","format":"double","example":0,"description":"Amount of premium the insured must pay the insurer to reinstate the coverage of the treaty after it is exhausted. Applies to `CATA` treaties only"},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double","example":150},"isValid":{"description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS.","type":"boolean","example":true},"userId1":{"type":"string","description":"User-defined property."},"userId2":{"type":"string","description":"User-defined property."},"aggregateDeductible":{"description":"For aggregate deductibles, losses from multiple events over a treaty’s in-force period can contribute to eroding the deductible. Applies to HD models only.","type":"number","format":"double","example":0},"aggregateLimit":{"description":"Limit that applies across all loss events during the treaty’s in-force period. Applies to HD models only.","type":"number","format":"double","example":0},"uri":{"type":"string","readOnly":true},"lobs":{"type":"array","description":"List of lines of business.","readOnly":true,"items":{"$ref":"#/components/schemas/LineOfBusinessInfo"}},"lossOccurrences":{"type":"array","description":"List of lost occurrences. A treaty loss occurrence is an an event, a portion of an event, or a collection of events to which reinsurance terms are applied to determine the split of liability.","readOnly":true,"items":{"$ref":"#/components/schemas/LossOccurrence"}},"tagIds":{"description":"List of tags to apply to treaty. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"UpdateTreatyInfo":{"required":["attachmentLevel","cedant","effectiveDate","expirationDate","occurrenceLimit","treatyNumber","treatyType"],"type":"object","properties":{"treatyId":{"readOnly":true,"description":"User-defined ID of treaty.","type":"integer","format":"int32","example":6},"treatyNumber":{"description":"Unique name of this treaty. Moody’s recommends using a combination of the cedant name, treaty type, and treaty terms.","maxLength":20,"minLength":0,"type":"string","example":"CID1-NCAT-20000"},"treatyName":{"description":"User-defined name of treaty.","maxLength":40,"minLength":0,"type":"string","example":"CSW-CATA-90"},"cedant":{"description":"Name of risk-holding party (insurer/reinsurer) that transfers a portion of its risk to another risk-holding party (reinsurer/retrocessionaire). Cedant must match an account's cedant for all cessions and treaties to be applied during the analysis.\n","$ref":"#/components/schemas/CedantInfo"},"producer":{"description":"Name of party licensed under a state to sell, solicit, or negotiate insurance.\n","$ref":"#/components/schemas/ProducerInfo"},"treatyType":{"description":"Type of treaty.","type":"string","example":"CATA","enum":["CATA","CORP","NCAT","QUOT","STOP","SURP","WORK"]},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"attachmentBasis":{"type":"string","description":"Defines how insurance policies have their losses covered. If `L` (losses occurring), claims are covered that occur during the period of this treaty. If `R` (risks attaching), claims are covered if policy inception occurs during period of this treaty","example":"L","enum":["L","R"]},"attachmentLevel":{"description":"Level at which treaty is attached. One of `ACCT` (account), `LOC` (location), `POL` (policy), `PORT` (portfolio)","type":"string","example":"ACCT","enum":["ACCT","LOC","POL","PORT"]},"premium":{"description":"Amount insurer or reinsurer charges to provide the coverage described in the policy or treaty","type":"number","format":"double","example":20000},"occurrenceLimit":{"description":"Maximum amount paid out for an event.","type":"number","example":1000000,"format":"double"},"attachmentPoint":{"description":"Amount at which the occurrence layer begins to take loss.","type":"number","format":"double","example":220000},"riskLimit":{"description":"Maximum amount paid out for risk in an event. Applies to `QUOT` and `SURP` treaties.","type":"number","example":200000},"retentionAmount":{"description":"Amount of risk or loss kept by the ceding company for its own account or for others.","type":"number","example":150,"format":"double"},"percentagePlaced":{"description":"Percentage of a treaty’s coverage that has been accepted by participating reinsurers.","type":"number","format":"double","example":60},"effectiveDate":{"description":"Effective date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date losses are eligible for recovery.","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"description":"Expiration date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date a loss-occurring policy/treaty/program no longer takes loss and a risks-attaching policy/treaty/program no longer allows risks to attach.","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentageRetention":{"description":"Percentage of the reinsurer’s share of treaty losses not covered by retrocessions. Determines the losses for the `RN` financial perspective and the net premium a reinsurer receives for a treaty","type":"number","format":"double","example":0},"percentageRiShare":{"type":"number","description":"Percentage of treaty coverage assigned to reinsurer. Used in calculation of `RG` perspective losses.","format":"double","example":90},"percentageCovered":{"type":"number","description":"Percentage of loss greater than the attachment point covered by a treaty. Not applicable to `SURP` treaties.","format":"double","example":50},"priority":{"description":"Inurning priority of this treaty. Lower numbers take losses prior to higher numbers.","type":"integer","format":"int32","example":3},"numberOfReinstatements":{"type":"integer","description":"Number of reinstatements. Restoration of the treaty occurrence limit to its full amount after an event that led to a non-zero reinsurance payout so that the reinsured has the full limit coverage for the next event occurrence.\n\nUsed in calculating catastrophe and corporate catastrophe treaty statistics, including average annual loss. The event loss table and the EP curves assume unlimited reinstatements","format":"int32","example":99},"reinstatementCharge":{"type":"number","format":"double","example":0,"description":"Amount of premium the insured must pay the insurer to reinstate the coverage of the treaty after it is exhausted. Applies to `CATA` treaties only"},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double","example":150},"isValid":{"description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS.","type":"boolean","example":true},"userId1":{"type":"string","description":"User-defined property."},"userId2":{"type":"string","description":"User-defined property."},"aggregateDeductible":{"description":"For aggregate deductibles, losses from multiple events over a treaty’s in-force period can contribute to eroding the deductible. Applies to HD models only.","type":"number","format":"double","example":0},"aggregateLimit":{"description":"Limit that applies across all loss events during the treaty’s in-force period. Applies to HD models only.","type":"number","format":"double","example":0},"uri":{"type":"string","readOnly":true},"lobs":{"type":"array","description":"List of lines of business.","readOnly":true,"items":{"$ref":"#/components/schemas/LineOfBusinessInfo"}},"lossOccurrences":{"type":"array","description":"List of lost occurrences. A treaty loss occurrence is an an event, a portion of an event, or a collection of events to which reinsurance terms are applied to determine the split of liability.","readOnly":true,"items":{"$ref":"#/components/schemas/LossOccurrence"}},"tagIds":{"description":"List of tags to apply to treaty. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"LocationConditionValidationInfo":{"type":"object","properties":{"message":{"type":"string"},"policyNumber":{"description":"ID of policy.","type":"string"},"locationNumber":{"type":"string"},"locationName":{"type":"string"},"condition1":{"type":"string"},"condition2":{"type":"string"}}},"AggregatePortfolio":{"required":["aggregatePortfolioName","aggregatePortfolioNumber","cedant","peril"],"type":"object","properties":{"aggregatePortfolioId":{"type":"integer","description":"ID of aggregate portfolio.","format":"int32","readOnly":true},"aggregatePortfolioNumber":{"description":"Number of aggregate portfolio.","maxLength":20,"minLength":0,"type":"string"},"aggregatePortfolioName":{"description":"Name of aggregate portfolio.","maxLength":40,"minLength":0,"type":"string"},"source":{"maxLength":10,"minLength":0,"type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"currency":{"description":"","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"createDate":{"type":"string","readOnly":true},"peril":{"type":"string","enum":["EQ","FLOOD","WINDSTORM","SEVERE_CONVECTIVE_STORM_WINTER_STORM","WILDFIRE"]},"uri":{"type":"string","readOnly":true},"tagIds":{"description":"List of tags to apply to aggregate portfolio. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"AggregatePortfolioSearchItem":{"required":["aggregatePortfolioName","aggregatePortfolioNumber","cedant","peril"],"type":"object","properties":{"aggregatePortfolioId":{"type":"integer","description":"ID of aggregate portfolio.","format":"int32","readOnly":true},"aggregatePortfolioNumber":{"description":"Number of aggregate portfolio.","maxLength":20,"minLength":0,"type":"string"},"aggregatePortfolioName":{"description":"Name of aggregate portfolio.","maxLength":40,"minLength":0,"type":"string"},"source":{"maxLength":10,"minLength":0,"type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"currency":{"description":"","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"peril":{"type":"string","enum":["EQ","FLOOD","WINDSTORM","SEVERE_CONVECTIVE_STORM_WINTER_STORM","WILDFIRE"]},"uri":{"type":"string","readOnly":true},"ownerName":{"type":"string","description":"Name of owner."},"tagIds":{"description":"List of tags applied to aggregate portfolio.","type":"array","items":{"type":"integer","format":"int32"}}}},"Archive":{"type":"object","properties":{"expirationDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"}}},"MoveExposureRequest":{"type":"object","required":["serverId"],"properties":{"serverId":{"type":"integer","format":"int64","minimum":1,"description":"ID of <<glossary:managed SQL Server instance>> on Data Bridge."}}},"AggregatePortfolioMetrics":{"type":"object","properties":{"totalAggregateExposures":{"type":"integer","format":"int32"},"perilsExposed":{"type":"string"},"total":{"type":"number","format":"double"},"name":{"type":"string"},"number":{"type":"string"},"source":{"type":"string"},"currency":{"type":"string"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"},"owner":{"type":"string"},"cedant":{"type":"string"}}},"AggregatePortfolioCountryMetrics":{"type":"object","properties":{"countryMetrics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"AlmErrorMessage":{"type":"object","properties":{"row":{"type":"string"},"column":{"type":"string"},"text":{"type":"string"}}},"AggregateExposuresList":{"type":"object","properties":{"values":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"lobs":{"type":"array","description":"List of lines of business.","items":{"type":"string"}},"resolutionValues":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"errorMessages":{"type":"array","items":{"$ref":"#/components/schemas/AlmErrorMessage"}},"countryCode":{"type":"string"},"resolution":{"type":"string"},"dependencyResolution":{"type":"string"}}},"LocationAal":{"type":"object","properties":{"locationId":{"type":"integer","format":"int32","example":60,"description":"ID of location."},"locationName":{"type":"string","example":"Location_name","description":"Name of location."},"locationNumber":{"type":"string","example":"Location_num","description":"User-defined ID of location."},"aal":{"type":"number","format":"double","description":"Expected value of the modeled loss distribution, i.e. losses that one would expect to see in a year on average. Since the AAL represents only an average, the actual annual losses will fluctuate around the AAL in any given year. AAL does not include expenses, non-modeled loss, profit, or risk load. ","example":294.25022798552993},"stdDev":{"type":"number","description":"Standard deviation from mean loss value.","format":"double","example":1663.1549792686967},"cv":{"type":"number","description":"Measure of the relationship between `aal` value (pure premium) and `stdDev` value (standard deviation) of the annual losses. Reflects the volatility in the annual losses.","format":"double","example":6.62779067641994}}},"EpInterpolate":{"type":"object","properties":{"returnPeriod":{"description":"Point on an EP curve that describes the likelihood of exceeding a loss threshold from the single largest event (OEP) or the aggregation of one or more events (AEP). ","type":"number","format":"double","example":13},"criticalProbability":{"description":"Likelihood of exceeding a loss threshold at a specific return period in an EP curve. Defined as the inverse of the annual exceedance probability. ","type":"number","format":"double","example":0.075},"result":{"type":"array","items":{"$ref":"#/components/schemas/EpInterpolateMetric"}}}},"EpInterpolateMetric":{"type":"object","properties":{"perspectiveCode":{"description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](financial-perspectives)","type":"string","example":"GR","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/EpInterpolateMetricMetaData"}}}},"EpInterpolateMetricMetaData":{"type":"object","properties":{"metricName":{"description":"EP curve for modeled losses, e.g. `AEP`, `OEP`, `TCE-AEP`, `TCE-OEP`.","type":"string","example":"TCE-OEP"},"metricValue":{"description":"Modeled losses at interpolated return period. ","type":"number","format":"double","example":"68418.2476820577"}}},"EPMetricValue":{"type":"object","properties":{"returnPeriods":{"type":"array","description":"List of return periods. A return period is a point on an EP curve that describes the likelihood of exceeding a loss threshold from the single largest event (OEP) or the aggregation of one or more events (AEP).  ","example":[50000,10000,5000,1000,500,250,200,100,50,25,10,5,2],"items":{"type":"number","format":"double"}},"positionValues":{"type":"array","example":[0.002,0.01,0.02,0.1,0.2,0.4,0.5,1,2,4,10,20,50],"description":"Likelihood of exceeding a loss threshold.","items":{"type":"number","format":"double"}}}},"EpMetricsOutput":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64","example":42376248},"epType":{"type":"string","description":"Type of _exceedence probability metrics_. One of `AEP` (aggregate EP), `CEP` (stochastic conditional EP), `OEP` (occurrence EP), `TCE_AEP` (tail conditional expectation AEP), `TCE_OEP` (tail conditional expectation OEP)","enum":["AEP","CEP","OEP","TCE-AEP","TCE-OEP","UNRECOGNIZED"],"example":"OEP"},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  ","example":"GR","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113},"exposureResourceType":{"description":"Type of exposure resource.","type":"string","example":"ACCOUNT","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"exposureResourceNumber":{"description":"User-defined ID for exposure resource.","type":"string","example":456},"value":{"description":"Object that defines lists of `returnPeriods` and `positionValues`. A position value represents the probability of exceeding a loss threshold during a specific particular return period.  ","$ref":"#/components/schemas/EPMetricValue"}}},"EventLossItem":{"type":"object","properties":{"analysisId":{"type":"integer","format":"int64","description":"ID of analysis result.","example":16738},"sourceId":{"type":"integer","format":"int32","description":"ID of source. Peril model-specific property that links related events, e.g. events of different magnitudes that share the same source (\"Calaveras Fault\")  ","example":21477},"eventId":{"type":"integer","format":"int32","description":"ID of an event, a representation of a peril that may produce catastrophe losses.","example":2864907},"positionValue":{"type":"number","description":"Mean loss incurred for event. Based on the granularity and financial perpective specified in the output profile.","format":"double","example":182961890.62228483},"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  ","example":"GR","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"stdDevI":{"type":"number","format":"double","description":"Standard deviation from mean loss value.\n\nIndependent standard deviation assumes that all locations are completely independent, which means that knowing the size of the loss at one location does not provide any information about the size of the loss at the other location.","example":13084002.9308518},"stdDevC":{"type":"number","description":"Standard deviation from mean loss value.\n\nCorrelated standard deviation assumes that all locations are correlated, which implies that if the losses are large for one location, they are likely to be large for the other location.","format":"double","example":97423142.35982497},"expValue":{"description":"Maximum loss that can be incurred for the event.","type":"number","format":"double","example":3464996216.86613},"rate":{"type":"number","format":"double","description":"Annual rate of event occurrence, i.e. _primary uncertainty_. Probability of the event occurring within a year. ","example":5.9357381587688e-7},"peril":{"type":"string","description":"Name of peril.","enum":["Unrecognized","Accumulation","Earthquake","Fire","Flood","Infectious Disease","Multi-Peril","Severe Convective Storm","Terrorism","Tornado","Hurricane","Unknown","Wildfire","Windstorm","Winterstorm"],"example":"Windstorm"},"region":{"description":"Region of exposure.","type":"string","example":"North America"},"oepWUC":{"type":"number","description":"Annual probability of occurrence without <<glossary:secondary uncertainty>>.   ","format":"double","example":0.000018740929793703565},"exposureResourceId":{"type":"integer","description":"ID of exposure.","format":"int32","example":234},"exposureResourceType":{"type":"string","description":"Type of exposure.","example":"PORTFOLIO","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"exposureResourceNumber":{"type":"string","description":"User-defined ID number of exposure.","example":"AU_NRES"}}},"MarginalEp":{"type":"object","properties":{"exposureResourceId":{"type":"integer","format":"int32","example":234},"exposureResourceType":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"exposureResourceNumber":{"type":"string","example":"AU_NRES"},"perspectiveCode":{"description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  ","type":"string","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"epType":{"type":"string","description":"Type of _exceedence probability metrics_. One of `AEP` (aggregate EP), `CEP` (stochastic conditional EP), `OEP` (occurence EP), `TCE_AEP` (tail conditional expectation AEP), `TCE_OEP` (tail conditional expectation OEP)","enum":["AEP","CEP","OEP","TCE-AEP","TCE-OEP","UNRECOGNIZED"]},"value":{"$ref":"#/components/schemas/MarginalEpValue"}}},"MarginalEpValue":{"type":"object","properties":{"returnPeriods":{"type":"array","example":[1,2,3,4,5],"description":"List of return periods. A return period is a point on an EP curve that describes the likelihood of exceeding a loss threshold from the single largest event (OEP) or the aggregation of one or more events (AEP). The return period is defined as the inverse of the annual exceedance probability. ","items":{"type":"integer","format":"int32"}},"eps":{"type":"array","items":{"type":"number","format":"double"}},"positionValues":{"type":"array","example":[0,0,0,1.4336826286215238,2898128.185059362],"items":{"type":"number","format":"double"}},"positionValueDiffs":{"type":"array","description":"List of position value differential values.","items":{"type":"number","format":"double"}},"positionValueDiffPercents":{"type":"array","description":"List of position value differential values.","items":{"type":"number","format":"double"}}}},"MarginalStats":{"type":"object","properties":{"exposureResourceId":{"description":"ID of exposure analyzed.","type":"integer","format":"int32","example":26113},"exposureResourceType":{"type":"string","description":"Type of exposure analyzed.","example":"TREATY","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"exposureResourceNumber":{"type":"string","description":"User-defined ID for modeled treaty.","example":"Cat_EntirePort_04"},"perspectiveCode":{"type":"string","description":"Financial perspective used to calculate analysis. See [Financial Perspectives](doc:financial-perspectives).","example":"TY","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"epType":{"type":"string","description":"Type of _exceedence probability metrics_. One of `AEP` (aggregate EP), `CEP` (stochastic conditional EP), `OEP` (occurence EP), `TCE_AEP` (tail conditional expectation AEP), `TCE_OEP` (tail conditional expectation OEP)","enum":["AEP","CEP","OEP","TCE-AEP","TCE-OEP","UNRECOGNIZED"]},"limit":{"type":"number","description":"The exposure value is the maximum loss that can be incurred at treaty layer, i.e. _loss layer_. ","example":900000,"format":"double"},"exhaustion":{"description":"Probability that a loss layer (`limit`) is exhausted based on OEP curve. ","type":"number","format":"double","example":0.06465721482368603},"activation":{"type":"number","description":"Probability that loss layer (`limit`) is activated based on OEP curve.","format":"double","example":0.19734192801321804},"cv":{"type":"number","description":"Coefficient of variation, a measurement of relationship between the `purePremium` and `totalStdDev` of annual losses.","format":"double","example":2.808502733065068},"cvDiff":{"type":"number","description":"Coefficient of variation associated with the portion of catastrophe treaty loss before reinstatements.","format":"double","example":2.7163077811358347},"cvDiffPercent":{"type":"number","format":"double"},"totalStdDev":{"type":"number","format":"double","description":"Standard deviation associated with the portion of catastrophe treaty loss.","example":3676637.4187586145},"totalStdDevDiff":{"type":"number","format":"double"},"totalStdDevDiffPercent":{"type":"number","format":"double"},"totalLossRatio":{"description":"Probability aggregate losses in a year are greater than orequal to the premium. Based on the AEP curve. ","type":"number","format":"double","example":0.17429420184027278},"netStdDev":{"type":"number","description":"Standard deviation associated with the portion of catastrophe treaty loss before reinstatements.","format":"double","example":231466.464883724},"premium":{"description":"Premium coded for the treaty.","type":"number","format":"double"},"purePremium":{"description":"Expected value of the aggregate loss distribution. ","type":"number","format":"double","example":493148.5493424345},"purePremiumDiff":{"type":"number","format":"double"},"purePremiumDiffPercent":{"description":"Risk on line: `premium` as a percentage of `limit`.","type":"number","format":"double","example":2.7777777777777777},"netPurePremium":{"description":"Estimate of premium required to balance risk, considering the reinstatement premiums to be paid. Base figure for catastrophe treaties with reinstatement provisions.","type":"number","format":"double","example":85213.63686810755},"exhaustAllReinstatements":{"description":"Probability that aggregate treaty payout exceeds Reinstatements (%) (k+1) \\* treaty occurrence limit, where _k_ is the number of reinstatements. Applicable to catastrophe treaties only.","type":"number","format":"double","example":0.0004301273657816296}}},"KeyLossItem":{"type":"object","properties":{"eventId":{"type":"integer","format":"int32","description":"ID of loss-causing event.","example":2864907},"stdDev":{"type":"number","format":"double","description":"Standard deviation from `meanLoss` value that characterizes the secondary uncertainty associated with that `meanLoss` value.","example":1663.1549792686967},"meanLoss":{"type":"number","format":"double","description":"Expected loss for an event for the corresponding position or <<glossary:financial perspective>>."},"cv":{"type":"number","format":"double","example":6.62779067641994,"description":"Relative uncertainty in the mean estimate of a loss, such as between financial perspectives or portfolios. Calculated by dividing `stdDev` of event losses by the `meanLoss`."}}},"KeyEventStatItem":{"type":"object","properties":{"eventId":{"type":"integer","format":"int32","description":"ID of an <<glossary:stochastic event>>.","example":2864907},"stdDev":{"type":"number","format":"double","description":"Standard deviation from `meanLoss` value.","example":1663.1549792686967},"meanLoss":{"type":"number","format":"double","description":"Expected loss for an event for the corresponding position or financial perspective."},"cv":{"type":"number","format":"double","example":6.62779067641994,"description":"Relative uncertainty in the mean estimate of a loss, such as between financial perspectives or portfolios. Calculated by dividing standard deviation of the event losses by the mean loss."},"targetId":{"type":"integer","format":"int64","description":"ID of target of attack. Value depends on analysis type of result.\n\n- If `Spider-SDF`, _0_.\n- If `Scenario` or `Terrorism Simple Footprint`, from target table in Target database. See [Target Databases](https://support.rms.com/documents/10192/0/INTL_PTM_TSM_TargetDatabase.pdf/18fe45d1-8cf3-446c-b8ae-534a26b9079f).","example":4038},"eventName":{"type":"string","example":"Empire State Building-Airplane.","description":"Name of event. \n\n- If single attack, concatenation of target name and method of attack, e.g. _Empire State Building-Airplane_.\n- If swarm attack, concatenation of `methodOfAttackId` and list of `targetId`s, e.g. _100: 4038;5056;12159;22797_."},"latitude":{"type":"string","description":"Latitude coordinates of target.","example":41.80156245},"longitude":{"type":"string","description":"Longitude coordinates of target.","example":-88.20092143},"eventType":{"type":"string","description":"Code of event type. For Terrorism HD models, `STOC` (stochastic) to indicate stochastic events that are part of the probabilistic model.","example":"STOC"},"peril":{"type":"string","description":"Natural or man-made phenonmon that generates insurance loss.","example":"TR"},"region":{"type":"string","description":"Code for peril region. ","example":"ZZ"},"methodOfAttackId":{"type":"integer","format":"int32","description":"ID of method of attack.\n\n`100` (Bombs), `200` (Aircraft Impact), `300` (Conflagration), `400` (Radiological - Dirty Bomb), `500` (Chemical - Sarin Gas), `600` (Biological: Anthrax and Smallpox), `700` (Nuclear Bomb), `800` (Sabotage: Industrial Plant- Explosion and Vapor Release), `870` (Sabotage: Hazmat Transportation), `900` (Nuclear Plant)"},"radius":{"type":"integer","format":"int32","description":"Radius of attack. From `simpledamagefootprint` table in Target database. See [Target Databases](https://support.rms.com/documents/10192/0/INTL_PTM_TSM_TargetDatabase.pdf/18fe45d1-8cf3-446c-b8ae-534a26b9079f).","example":1600},"radiusUnit":{"type":"string","description":"Unit of measurement used for `radius` distance.  From `simpledamagefootprint` table in Target database. See [Target Databases](https://support.rms.com/documents/10192/0/INTL_PTM_TSM_TargetDatabase.pdf/18fe45d1-8cf3-446c-b8ae-534a26b9079f).","example":"meters"},"countryScheme":{"type":"string","description":"Standard for user-supplied country code.","example":"ISO2A"},"countryCode":{"type":"string","description":"Two-letter code for target country.","enum":["BE","CA","DK","FR","GB","IE","IT","TR","US","VA"],"example":"US"},"admin1Code":{"type":"string","description":"Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces.","example":"NY"},"admin1Name":{"type":"string","description":"Name of administrative level 1.","example":"NEW YORK"},"admin2Code":{"type":"string","description":"Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties","example":1},"admin2Name":{"type":"string","description":"Name of administrative level 2.","example":"New York County"},"cityName":{"type":"string","description":"Name of target city.See [Target Databases](https://support.rms.com/documents/10192/0/INTL_PTM_TSM_TargetDatabase.pdf/18fe45d1-8cf3-446c-b8ae-534a26b9079f). ","example":"New York"},"postalCode":{"type":"string","example":10017}}},"PeriodLossItem":{"type":"object","properties":{"periodId":{"type":"integer","format":"int32","example":503,"description":"ID of <<glossary:simulation period>>. "},"weight":{"type":"number","format":"double","example":0.00002,"description":"Likelihood that a <<glossary:simulation period>> occurs relative to the other simulation periods."},"eventId":{"type":"integer","format":"int32","description":"ID of event, a representation of a peril that may produce catastrophe losses.","example":3508644},"eventDate":{"type":"string","example":"2020-08-07T00:00:00.000Z","description":"Date that the event occurred."},"lossDate":{"description":"Date of first policy payout.","type":"string","example":"2020-08-13T00:00:00.000Z"},"positionValue":{"type":"number","description":"Mean loss incurred for event. Based on the granularity and financial perpective specified in the output profile.","format":"double","example":111642.35349968076},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss.","enum":["Unrecognized","Accumulation","Earthquake","Fire","Flood","Infectious Disease","Multi-Peril","Severe Convective Storm","Terrorism","Tornado","Hurricane","Unknown","Wildfire","Windstorm","Winterstorm"]},"region":{"type":"string","description":"Model region of the analysis."},"exposureResourceNumber":{"type":"string"}}},"Perspective":{"type":"object","properties":{"perspectiveCode":{"type":"string","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)  "},"perspectiveName":{"type":"string"}}},"SampledLossItem":{"type":"object","properties":{"cedantName":{"type":"string","description":"Name of risk-holding party that transfers a portion of its risk to another risk-holding party.","example":"CSW"},"lobName":{"type":"string","description":"Name of line business, e.g.,  commercial, personal, auto, or residence.","example":"FACTORY"},"lossType":{"type":"string","description":"Type of loss. One of  `All`, `Building`, `Contents`, `BI`, `Combined Coverage` ","example":"Building","enum":["Building","Contents","BI","CombinedCvg"]},"sampleId":{"type":"integer","format":"int32","description":"ID of sample.","example":17},"eventId":{"type":"integer","format":"int32","description":"ID of event, a representation of a peril that may produce catastrophe losses. ","example":80012447},"loss":{"type":"number","description":"Expected <<glossary:sampled loss>> based on the position or financial perspective.","format":"double","example":5273411175.0125885}}},"StatisticsItem":{"type":"object","properties":{"analysisId":{"type":"integer","format":"int64","description":"ID of analysis.","example":54},"exposureResourceId":{"type":"integer","format":"int64","description":"ID of analyzed exposure resource.","example":765},"exposureResourceType":{"type":"string","description":"Type of analyzed exposure resource.","example":"ACCOUNT","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"perspectiveCode":{"type":"string","description":"Financial perspective considered in calculation of the loss statistics. See [Financial Perspectives](ref:financial-perspectives).","example":"TY","enum":["C0","C1","C2","C3","C4","C5","C6","CG","CL","DC","EL","FA","G1","G2","GR","GS","GU","I0","I1","I2","I3","I4","I5","I6","IG","L1","L2","L3","L4","L5","L6","LG","M0","M1","M2","M3","M4","M5","M6","MG","NL","NP","OI","OL","PY","QS","RC","RG","RL","RN","RP","SS","TE","TG","TN","TV","TY","UC","VA","VL","VP","VT","VY","WX"]},"epType":{"type":"string","description":"Type of <<glossary:EP curve>>, i.e. `OEP` (occurence EP).","enum":["OEP"]},"purePremium":{"type":"number","format":"double","description":"Expected value of the aggregate loss distribution.\nPure premium can be computed in two equivalent ways. First, as the area under the aggregate exceedance probability (AEP) curve, or second, as the sum-product of the individual event losses and rates."},"totalStdDev":{"type":"number","format":"double","description":"Standard deviation associated with the portion of catastrophe treaty loss before reinstatements."},"cv":{"type":"number","format":"double","description":"Volatility in the annual losses. CV (coefficient of variation) provides a comparative basis for assessing diversification of risk and compares volatility across analyses, such as between portfolios.","example":2.808502733065068},"netPurePremium":{"type":"number","format":"double","example":85213.63686810755,"description":"Estimate of premium required to balance risk, considering the reinstatement premiums to be paid. Base figure for catastrophe treaties with reinstatement provisions."},"activation":{"type":"number","format":"double","example":0.19734192801321804,"description":"Probability that `limit` value is activated based on the OEP curve."},"exhaustion":{"type":"number","format":"double","example":0.06465721482368603,"description":"Probability that `limit` value is exhausted based on the OEP curve."},"totalLossRatio":{"type":"number","format":"double","description":"Probability aggregate losses in a year are greater than or equal to the premium. Based on the AEP curve.","example":0.17429420184027278},"limit":{"type":"number","format":"double","example":900000,"description":"ELT `expValue` treaty layer amount, i.e. the maximum loss that can be incurred for each event at the perspective and aggregation level with which the exposure value is associated."},"premium":{"type":"number","format":"double","example":25000,"description":"Premium specified in the treaty."},"netStdDev":{"type":"number","format":"double","example":231466.464883724,"description":"Standard deviation associated with the portion of catastrophe treaty loss before reinstatements."},"exhaustAllReinstatements":{"type":"number","format":"double","example":0.0004301273657816296,"description":"Probability that aggregate treaty payout exceeds Reinstatements (%) (k+1) * treaty occurrence limit, where k is the number of reinstatements. Applicable to catastrophe treaties only."},"exposureResourceNumber":{"type":"string","example":"Cat_EntirePort","description":"User-defined ID of modeled resource."}}},"MarginalImpactInput":{"required":["marginalImpactAnalysisIds","outputLevel","jobName","eventRateSchemeIds"],"type":"object","properties":{"marginalImpactAnalysisIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"List of account-level analysis results identified by ID. "},"currency":{"$ref":"#/components/schemas/AnalysisCurrency"},"outputLevel":{"type":"string","enum":["ACCOUNT","POLICY"]},"jobName":{"type":"string","description":"Name of Marginal Impact Analysis job."},"eventRateSchemeIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"List of <<glossary:event rate scheme>>s by ID."},"tagIds":{"description":"List of tags to apply to this analysis treaty.","type":"array","items":{"type":"integer","format":"int32"}}}},"DownloadRollupContributoryMetricsRequest":{"required":["positionUuid","fileExtension"],"type":"object","properties":{"positionUuid":{"description":"UUID of a position, i.e. a `PORTFOLIO` (<<glossary:risk source>>), `PROGRAM` (<<glossary:program>>), or `GROUP` (collection of diverse positions).\n\n- If `PORTFOLIO`, metrics are segmented by account where available. \n- If `PROGRAM`, metrics are segmented by <<glossary:program treaty>>.\n- If `GROUP`, metrics are segmented by both accounts and program treaties.","type":"string","format":"uuid","example":"f67a1745-c9b6-4f42-ac36-a78268091159"},"contributionOf":{"description":"List of granularities for contributory metric segmentation.","type":"array","items":{"type":"string","enum":["Admin1","Contract","Country"],"example":"Country"}},"contributionTo":{"description":"List of granularities for contributory metrics segmented by program treaty.","type":"array","items":{"type":"string","enum":["Continent","Country","Peril"],"example":"Peril"}},"fileExtension":{"description":"Extension of downloadable contributory metrics file. ","type":"string","enum":["JSON","CSV"]}}},"DownloadRollupContributoryMetricsResponse":{"type":"object","properties":{"downloadUrl":{"type":"string","format":"url"},"contributionOf":{"type":"array","items":{"type":"string","enum":["Contract","Admin1","Country"]}},"contributionTo":{"type":"array","items":{"type":"string","enum":["Peril","Continent","Country"]}}}},"MapPerspectiveInput":{"required":["mapPerspectiveOption","newPerspective","sourcePerspective"],"type":"object","properties":{"analysisName":{"maxLength":64,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string","description":"Name of analysis result. Valid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters.\n","example":"NewAnalysisName"},"sourcePerspective":{"type":"string","description":"Financial perspective used in original analysis."},"newPerspective":{"type":"string","description":"Financial perspective to use in new analysis."},"mapPerspectiveOption":{"type":"string","description":"Method used to map financial perspectives.","enum":["DELETE_OTHER","INCLUDE_DOWNSTREAM","SELECTED_ONLY"]}}},"ClimateChange":{"required":["climateConditionView","rcpScenario","referenceRateSchemeId","timeHorizon"],"type":"object","properties":{"analysisName":{"maxLength":64,"minLength":0,"type":"string","description":"Name of the new analysis. Can be alpha-numeric string.","example":"ABC Climate"},"climateConditionView":{"type":"string","description":"For North Atlantic Hurricane Models analyses only.\n\n- If `Frequency and Intensity Only`, model is conditioned based on frequency and intensity only.\n- If `Combined All Parameters`, model is conditioned based on frequency,intensity, storm size, and track location. ","example":"Combined All Parameters","enum":["Default","Combined All Parameters","Frequency and Intensity Only"]},"referenceRateSchemeId":{"type":"integer","description":"ID of <<glossary:event rate>> conditioned for climate change. One of `190`, `202`, `84`,`9`.  \n * `190` RMS 2019 Historical Event Rates\n * `202` RMS 2021 Historical Event Rates\n * `84`  RMS 2015 Stochastic Event Rates  \n * `9`   RMS v2.0 Default Rates","format":"int32","example":190},"rcpScenario":{"type":"number","description":"RCP scenario needed for this climate change analysis. One of `2.6`, `4.5`, `6.0`, `8.5`\n\n* `2.6`: A pathway where radiative forcing peaks at approximately 3 W m-2 before 2100 and then declines to 2.6 W m-2.\n* `4.5`: An intermediate stabilization pathway in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.\n* `6.0`: An intermediate stabilization pathways in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.\n* `8.5`: A high pathway for which radiative forcing reaches greater than 8.5 W m-2 by 2100 and continues to rise for some amount of time.","format":"double","example":2.6},"timeHorizon":{"type":"integer","description":"One or more snapshots included in an RCP scenario-based analysis. Values must be between `2020` and `2100` in five year increments, e.g.  _2020, 2025, 2030, 2035_. ","format":"int32","example":2025},"is2CWarmingScenario":{"type":"boolean","description":"Indicates whether climate change analysis includes RCP scenarios. If no `rcpScenario` or `timeHorizon` vlaues are specified, set to `false`."}}},"ClimateChangeRcp":{"type":"object","required":["referenceRateSchemeId","climateConditionView","timeHorizon","sspScenario"],"properties":{"type":{"type":"string","enum":["rcp"]},"analysisName":{"description":"Name of climate change analysis. Can be alphanumeric string.","type":"string","example":"ABC Climate"},"climateConditionView":{"description":"For North Atlantic Hurricane Models analyses only.\n\n- If `Frequency and Intensity Only`, model is conditioned based on frequency and intensity only.\n- If `Combined All Parameters`, model is conditioned based on frequency,intensity, storm size, and track location. ","type":"string","example":"Combined All Parameters","enum":["Combined All Parameters","Frequency and Intensity Only","Default"]},"referenceRateSchemeId":{"description":"ID of <<glossary:event rate>> scheme conditioned for climate change. One of `190`, `202`, `84`, `9`.\n* `190`: RMS 2019 Historical Event Rates\n* `202`: RMS 2021 Historical Event Rates\n* `84`: RMS 2015 Historical Event Rates\n* `9`: RMS v2.0 Default Rates\n","type":"integer","format":"int32","example":190,"enum":[190,202,84,9]},"rcpScenario":{"description":"RCP scenario. One of `2.6`, `4.5`, `6.0`, or `8.5`.\n* `2.6`: A pathway where radiative forcing peaks at approximately 3 W m-2 before 2100 and then declines to 2.6 W m-2.\n* `4.5`: An intermediate stabilization pathway in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.\n* `6.0`: An intermediate stabilization pathways in which radiative forcing is stabilized at approximately 4.5 W m-2 and 6.0 W m-2 after 2100.\n* `8.5`: A high pathway for which radiative forcing reaches greater than 8.5 W m-2 by 2100 and continues to rise for some amount of time.\n","type":"number","format":"double","example":2.6,"enum":[2.6,4.5,6,8.5]},"timeHorizon":{"description":"One or more the snapshots included in an RCP scenario-based analysis. Values must be between `2020` and `2100` in five year increments. For example, `2020, 2025, 2030, 2035`\n","type":"integer","format":"int32","example":2025},"is2CWarmingScenario":{"description":"Indicates whether the climate change analysis includes RCP scenarios. If no `rcpScenario` or `timeHorizon` values are specified, set to `false`.\n","type":"boolean"}}},"ClimateChangeSsp":{"type":"object","required":["type","referenceRateSchemeId","climateConditionView","timeHorizon","sspScenario"],"properties":{"type":{"type":"string","enum":["ssp"]},"analysisName":{"description":"Name of climate change analysis. Can be alphanumeric string.","type":"string","example":"ABC Climate"},"climateConditionView":{"description":"One of `Combined All Parameters`, `Frequency and Intensity Only`, `Default`\n\n* If `Frequency and Intensity Only`, model is conditioned based on frequency and intensity only.\n* If `Combined All Parameters`, model is conditioned based on frequency,intensity, storm size, and track location. ","type":"string","enum":["Default","Combined All Parameters","Frequency and Intensity Only"]},"sspScenario":{"type":"string","enum":["1-2.6","2-4.5","3-7.0","5-8.5"]},"referenceRateSchemeId":{"description":"ID of <<glossary:event rate>> scheme conditioned for climate change.\n\n* `190`: RMS 2019 Historical Event Rates\n* `202`: RMS 2021 Historical Event Rates\n* `84`: RMS 2015 Historical Event Rates\n* `9`: RMS v2.0 Default Rates","type":"integer","format":"int32","example":190,"enum":[190,202,84,9]},"timeHorizon":{"description":"One or more the snapshots included in an RCP scenario-based analysis. Values must be between `2020` and `2100` in five year increments. For example, `2020, 2025, 2030, 2035`\n","type":"integer","format":"int32"},"is2CWarmingScenario":{"description":"Indicates whether the climate change analysis includes RCP scenarios. If no `rcpScenario` or `timeHorizon` values are specified, set to `false`.\n","type":"boolean"}}},"SimulateEltToPlt":{"type":"object","properties":{"eventRateSchemeId":{"minimum":1,"type":"integer","format":"int32","description":"ID of the <<glossary:event rate scheme>> to use to compute PLT. "},"simulationSetId":{"minimum":1,"type":"integer","format":"int32","description":"ID of period event quantile table (PEQT)."},"simulationPeriods":{"minimum":1,"type":"integer","format":"int64","description":"Number of <<glossary:simulation period>>s to use to compute PLT."},"regionPerilSettings":{"type":"array","description":"If present, the fields `eventRateSchemeId`, `simulationSetId`, and `simulationPeriods` are not allowed.\n","items":{"type":"object","properties":{"eventRateSchemeId":{"description":"ID of the <<glossary:event rate scheme>> used to calculate a PLT analysis. The PLT Engine substitutes the specified event rate scheme for the event rate scheme used in the ELT-based reference analysis.\n","type":"integer","format":"int32"},"simulationSetId":{"description":"ID of a period event quantile table (PEQT).\n","type":"integer","format":"int32"},"simulationPeriods":{"description":"Number of <<glossary:simulation period>>s used to generate the PLT.\n","type":"integer","format":"int64"},"modelRegionCode":{"description":"Code representing the model region.\n","type":"string"}}}}}},"AnalysisTreaty":{"required":["attachmentLevel","cedant","treatyNumber","treatyType"],"type":"object","properties":{"treatyId":{"type":"integer","format":"int32","description":"ID of treaty."},"treatyNumber":{"maxLength":20,"minLength":0,"type":"string","description":"Unique name of this treaty. Moody’s recommends using a combination of the cedant name, treaty type, and treaty terms.\n"},"treatyName":{"maxLength":40,"minLength":0,"type":"string","description":"Name of treaty."},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"treatyType":{"type":"string","description":"Type of treaty.","example":"CATA","enum":["CATA","QUOT","SURP","WORK","CORP","STOP","NCAT"]},"currency":{"description":"Currency used in treaty.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"attachmentBasis":{"type":"string","description":"Defines how insurance policies have their losses covered. If `L` (losses occurring), claims are covered that occur during the period of this treaty. If `R` (risks attaching), claims are covered if policy inception occurs during period of this treaty.\n","example":"R","enum":["L","R"]},"attachmentLevel":{"type":"string","description":"Level at which treaty is attached. One of `ACCT` (account), `LOC` (location), `POL` (policy), `PORT` (portfolio).\n","example":"PORT","enum":["PORT","ACCT","POL","LOC"]},"premium":{"type":"number","format":"double","description":"Amount an insurer or reinsurer charges to provide the coverage described in the policy or treaty.","example":20000},"occurrenceLimit":{"type":"number","format":"double","description":"Maximum amount that paid out for an event.\n","example":1000000},"attachmentPoint":{"type":"number","format":"double"},"riskLimit":{"type":"number","format":"double","description":"Maximum amount paid out for risk in an event. Applies to `QUOT` and `SURP` treaties.","example":200000},"retentionAmount":{"type":"number","format":"double","description":"Amount of risk or loss kept by the ceding company for its own account or for others."},"percentagePlaced":{"type":"number","format":"double","description":"Percentage of a treaty’s coverage that has been accepted by participating reinsurers."},"effectiveDate":{"type":"string","description":"Effective date of this treaty in format, e.g. _2020-01-01T00:00:00.000Z_. From this date losses are eligible for recovery.","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"type":"string","description":"Expiration date of this treaty in format, e.g. _2020-01-01T00:00:00.000Z_. From this date a loss-occurring policy/treaty/program no longer takes loss and a risks-attaching policy/treaty/program no longer allows risks to attach.","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentageRetention":{"type":"number","format":"double","description":"Percentage of the reinsurer’s share of treaty losses not covered by retrocessions. Determines the losses for the `RN` financial perspective and the net premium a reinsurer receives for a treaty.","example":0},"percentageRiShare":{"type":"number","format":"double","description":"Percentage of treaty coverage assigned to reinsurer. Used in calculation of `RG` perspective losses. ","example":90},"percentageCovered":{"type":"number","format":"double","description":"Percentage of loss greater than the attachment point covered by a treaty. Not applicable to `SURP` treaties.","example":50},"priority":{"type":"integer","format":"int32","description":"Inurning priority of this treaty. Lower numbers take losses prior to higher numbers.","example":3},"numberOfReinstatements":{"type":"integer","format":"int32","description":"Number of reinstatements. Restoration of the treaty occurrence limit to its full amount after an event that led to a non-zero reinsurance payout so that the reinsured has the full limit coverage for the next event occurrence\n\nUsed in calculating catastrophe and corporate catastrophe treaty statistics, including average annual loss. The event loss table and the EP curves assume unlimited reinstatements\n"},"reinstatementCharge":{"type":"number","format":"double","description":"Amount of premium the insured must pay the insurer to reinstate the coverage of the treaty after it is exhausted. Applies to `CATA` treaties only\n"},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"userId1":{"type":"string","description":"User-defined property."},"userId2":{"type":"string","description":"User-defined property."},"aggregateDeductible":{"type":"number","format":"double","description":"For aggregate deductibles, losses from multiple events over a treaty’s in-force period can contribute to eroding the deductible. Applies to HD models only.\n"},"aggregateLimit":{"type":"number","format":"double","description":"Limit that applies across all loss events during the treaty’s in-force period. Applies to HD models only.\n"},"uri":{"type":"string","readOnly":true},"lobs":{"type":"array","description":"List of lines of business.","readOnly":true,"items":{"$ref":"#/components/schemas/LineOfBusinessInfo"}},"lossOccurrences":{"type":"array","readOnly":true,"description":"List of lost occurrences. A treaty loss occurrence is an an event, a portion of an event, or a collection of events to which reinsurance terms are applied to determine the split of liability.","items":{"$ref":"#/components/schemas/LossOccurrence"}},"analysisId":{"type":"integer","format":"int64","description":"ID of analysis."},"tagIds":{"description":"List of tags to apply to this analysis treaty.","type":"array","items":{"type":"integer","format":"int32"}}}},"Pate":{"required":["attachmentLevel","operationType","treatyNumber","treatyType"],"type":"object","properties":{"treatyId":{"description":"User-defined ID of treaty","type":"integer","format":"int32"},"treatyNumber":{"description":"Unique name of this treaty. Moody’s recommends using a combination of the cedant name, treaty type, and treaty terms.\n","maxLength":20,"minLength":0,"type":"string"},"treatyName":{"description":"User-defined name of treaty","maxLength":40,"minLength":0,"type":"string"},"cedant":{"description":"Name of risk-holding party (insurer/reinsurer) that transfers a portion of its risk to another risk-holding party (reinsurer/retrocessionaire). Cedant must match an account's cedant for all cessions and treaties to be applied during the analysis.\n\nRequired if <<glossary:reference analysis>> is DLM analysis. If unspecified and reference analysis is HD analysis, treaty applies to entire analysis. ","$ref":"#/components/schemas/CedantInfo"},"producer":{"description":"Name of party licensed under a state to sell, solicit, or negotiate insurance.\n","$ref":"#/components/schemas/ProducerInfo"},"treatyType":{"type":"string","description":"Type of treaty.","example":"CATA","enum":["CATA","CORP","NCAT","QUOT","STOP","SURP","WORK"]},"currency":{"description":"","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"attachmentBasis":{"type":"string","description":"Defines how insurance policies have their losses covered. If `L` (losses occurring), claims are covered that occur during the period of this treaty. If `R` (risks attaching), claims are covered if policy inception occurs during period of this treaty.","example":"R","enum":["L","R"]},"attachmentLevel":{"description":"Level at which treaty is attached. One of `ACCT` (account), `LOC` (location), `POL` (policy), `PORT` (portfolio)\n","type":"string","example":"POL","enum":["ACCT","LOC","POL","PORT"]},"premium":{"description":"Amount an insurer or reinsurer charges to provide the coverage described in the policy or treaty\n","type":"number","format":"double"},"occurrenceLimit":{"description":"Maximum amount that paid out for an event\n","type":"number","format":"double"},"attachmentPoint":{"description":"Amount at which the occurrence layer begins to take loss.","type":"number","format":"double"},"riskLimit":{"type":"number","description":"Maximum amount paid out for risk in an event. Applies to `QUOT` and `SURP` treaties\n","format":"double"},"retentionAmount":{"description":"Amount of risk or loss kept by the ceding company for its own account or for others\n","type":"number","format":"double"},"percentagePlaced":{"description":"Percentage of a treaty’s coverage that has been accepted by participating reinsurers","type":"number","format":"double"},"effectiveDate":{"description":"Effective date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date losses are eligible for recovery\n","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"description":"Expiration date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date a loss-occurring policy/treaty/program no longer takes loss and a risks-attaching policy/treaty/program no longer allows risks to attach\n","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentageRetention":{"description":"Percentage of the reinsurer’s share of treaty losses not covered by retrocessions. Determines the losses for the `RN` financial perspective and the net premium a reinsurer receives for a treaty\n","type":"number","format":"double"},"percentageRiShare":{"description":"Percentage of treaty coverage assigned to reinsurer. Used in calculation of `RG` perspective losses\n","type":"number","format":"double"},"percentageCovered":{"description":"Percentage of loss greater than the attachment point covered by a treaty. Not applicable to `SURP` treaties.\n","type":"number","format":"double"},"priority":{"description":"Inurning priority of this treaty. Lower numbers take losses prior to higher numbers\n","type":"integer","format":"int32"},"numberOfReinstatements":{"description":"Number of reinstatements. Restoration of the treaty occurrence limit to its full amount after an event that led to a non-zero reinsurance payout so that the reinsured has the full limit coverage for the next event occurrence\n\nUsed in calculating catastrophe and corporate catastrophe treaty statistics, including average annual loss. The event loss table and the EP curves assume unlimited reinstatements\n","type":"integer","format":"int32"},"reinstatementCharge":{"description":"Amount of premium the insured must pay the insurer to reinstate the coverage of the treaty after it is exhausted. Applies to `CATA` treaties only\n","type":"number","format":"double"},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"userId1":{"type":"string","description":"User-defined property."},"userId2":{"type":"string","description":"User-defined property."},"aggregateDeductible":{"description":"For aggregate deductibles, losses from multiple events over a treaty’s in-force period can contribute to eroding the deductible. Applies to HD models only\n","type":"number","format":"double"},"aggregateLimit":{"description":"Limit that applies across all loss events during the treaty’s in-force period. Applies to HD models only\n","type":"number","format":"double"},"uri":{"type":"string","readOnly":true},"lobs":{"type":"array","description":"List of lines of business.","readOnly":true,"items":{"$ref":"#/components/schemas/LineOfBusinessInfo"}},"lossOccurrences":{"type":"array","description":"List of lost occurrences. A treaty loss occurrence is an an event, a portion of an event, or a collection of events to which reinsurance terms are applied to determine the split of liability.","readOnly":true,"items":{"$ref":"#/components/schemas/LossOccurrence"}},"analysisId":{"type":"integer","format":"int64"},"pateId":{"type":"integer","format":"int64"},"groupedAnalysisId":{"type":"integer","format":"int64"},"operationType":{"type":"string","writeOnly":true,"enum":["ADD","COPY","IMPORT","REMOVE","UPDATE"]},"tagIds":{"description":"List of tags to apply to this treaty.","type":"array","items":{"type":"integer","format":"int32"}}}},"PateInput":{"type":"object","properties":{"insert":{"description":"List of PATE treaties to attach before PATE analysis.","type":"array","items":{"$ref":"#/components/schemas/Pate"}},"update":{"description":"List of adjustments to base treaties (treaties attached to the base analysis) to update before PATE analysis. ","type":"array","items":{"$ref":"#/components/schemas/Pate"}},"delete":{"type":"array","description":"List of base treaties (treaties attached to the base analysis) to remove before PATE analysis. ","items":{"$ref":"#/components/schemas/Pate"}}}},"ConvertEventInput":{"type":"object","properties":{"analysisName":{"maxLength":64,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string","description":"Name of analysis result. Valid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters.\n","example":"NewAnalysisName"},"eventRateSchemeIds":{"type":"array","description":"List of <<glossary:event rate scheme>>s by ID.","items":{"type":"integer","format":"int32"}},"eventLossAdjustmentSchemeIds":{"type":"array","description":"List of event loss adjustment schemes by ID.","items":{"type":"integer","format":"int32"}},"overrideEventIds":{"type":"boolean","default":false,"description":"If true, overrides eventIds in the analysis with externalIds from event rate schemes"}}},"AnalysisAdditionalProperty":{"type":"object","properties":{"key":{"type":"string","description":"Name of property.","example":"simulationSets"},"properties":{"type":"array","description":"List of property objects. Each property may be defined by three values: `id`, `name`, and `value`.","items":{"$ref":"#/components/schemas/AnalysisAdditionalPropertyValue"}}}},"AnalysisAdditionalPropertyValue":{"type":"object","properties":{"id":{"type":"integer","description":"ID of property.","format":"int32","example":70},"name":{"type":"string","description":"Name of property.","example":"North Atlantic Hurricane, 2013 Historical Event Rates"},"value":{"type":"string","description":"Value of property.  May be `string`, `int`, or other data type depending on property.","example":""}}},"GetAnalysisResponse":{"type":"object","properties":{"analysisId":{"type":"integer","description":"ID of analysis result.","format":"int64","example":18415539},"analysisName":{"type":"string","description":"Name of analysis result.","example":"TestGroup"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","example":"2025-03-26T23:53:20"},"description":{"type":"string","description":"Description of analysis result.","example":""},"sourceRdmName":{"type":"string","example":""},"analysisRegroupType":{"type":"string","enum":["All","Not Required","Post perspectives","Recalculate reinsurance statistics","Recalculate treaty statistics","Reinsurance perspectives"]},"exposureResourceType":{"type":"string","description":"Type of exposure.","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"engineVersion":{"type":"string","description":"Version of model engine used in model profile. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL13","RL13.1","RL15","RL16","RL17","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24","PLTALM1.0","PLTGroup1.0","Unrecognized"]},"groupType":{"type":"string","description":"Type of group. One of `ANLS` (Single EP), `CDGP` (Cedant group), `INGP` (Independent group), `MCGP` (Muli-currency group), and `UNRECOGNIZED`.","enum":["ANLS","CDGP","INGP","MCGP","UNRECOGNIZED"],"example":"CDGP"},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113},"exposureName":{"type":"string","description":"Name of exposure (EDM).","example":"RMS_RL18_Ref_TestData_EDM"},"jobId":{"type":"integer","description":"ID of job.","format":"int64","example":42379997},"jobGuid":{"type":"string","description":"UUID of job.","example":"b709c590-5c88-4be0-9d8b-bcd085fda98f"},"isGroup":{"type":"boolean","description":"If `true`, analysis result is an <<glossary:analysis group>>.","example":false},"modelProfile":{"description":"Model profile used for analysis identified by `id`, `code`, and `name`.","$ref":"#/components/schemas/ExposureValue"},"outputProfile":{"description":"Output profile used for analysis identified by `id`, `code`, and `name`.","$ref":"#/components/schemas/ExposureValue"},"engineType":{"type":"string","description":"Engine used to process model job.","example":"DLM","enum":["ALM","CEP","CEPGroup","DLM","DLMExpress","Group","HD","HydraDLMExpress","Invalid"]},"analysisStatus":{"type":"string","description":"Status of analysis.","enum":["Analyzed","Analyzed Intermediate","Error in Analyzing","Error in persisting","Finished IFG","Finished event determination","Finished writing losses","Invalid","Not analyzed","Running EP engine","Running IFG","Running event determination","Writing losses"]},"analysisType":{"type":"string","description":"Type of analysis.","enum":["Building Level","CA DOI","Exceedance Probability","Footprint File","Historical","Maximum Credible","Maximum Historical","Probabilistic Loss Over Time","Scenario","Specific Area","Spider","Spider-SDF","Terrorism - Simple Footprint","Terrorism - VRG Footprint","Unrecognized","User Defined"]},"peril":{"type":"string","description":"Name of primary peril causing loss.","enum":["Accumulation","Earthquake","Fire","Flood","Hurricane","Infectious Disease","Multi-Peril","Severe Convective Storm","Terrorism","Tornado","Unknown","Unrecognized","Wildfire","Windstorm","Winterstorm"]},"subPeril":{"type":"string","description":"Name of secondary peril.\n\nAdditional modeled peril associated with or caused by primary `peril` causing loss.","enum":["All","Fire + Shake + Sprinkler Leakage (EQSL)","Fire + Sprinkler Leakage (EQSL)","Fire Only","Flood Only","Freeze Only","Hail + Wind","Hail Only","Ice + Freeze","Ice Only","Multi-SubPeril","None","Off + On Plain Flood","Off Plain Flood Only","On Plain Flood Only","Shake + Fire","Shake + Sprinkler Leakage (EQSL)","Shake Only","Snow + Freese","Snow + Ice","Snow + Ice + Freeze","Snow Only","Sprinkler Leakage (EQSL) Only","Surge + Flood","Surge + Wind","Surge + Wind + Flood","Surge Only","Tornado + Hail","Tornado + Hail + Wind","Tornado + Wind","Tornado Only","WInd + Flood","Wind + Freeze","Wind + Ice","Wind + Snow","Wind + Snow + Freeze","Wind + Snow + Ice","Wind + Snow + Ice + Freeze","Wind Only"]},"region":{"type":"string","description":"Region of analysis.","example":"North Atlantic (including Hawaii)"},"lossAmplification":{"type":"string","enum":["BI","Building","Building, BI","Building, Contents","Building, Contents, BI","Contents","Contents, BI","Mixed","None","Not Applicable","Unknown"],"example":"Building, Contents, BI"},"analysisMode":{"type":"string","description":"Mode of analysis.","enum":["Amount","Distributed","Expected","Percent","Simulated","Unrecognized"],"example":"Distributed"},"insuranceType":{"type":"string","enum":["Property","Property, Workers Comp","Unknown","Workers Comp"],"example":"Property"},"vulnerabilityCurve":{"type":"string","description":"<<glossary:Vulnerability curve>> used in analysis.","enum":["Vulnerability - Default","First alternate set of curves","Second alternate set of curves","Third alternate set of curves"],"example":"Vulnerability - Default"},"username":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that ran analysis, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"eventRateSchemeNames":{"type":"array","items":{"$ref":"#/components/schemas/ExposureValue"}},"currency":{"$ref":"#/components/schemas/AnalysisCurrency"},"engineSubType":{"type":"string","description":"Subtype of engine.","enum":["Climate Change","Marginal Impact","Not Applicable","Simulated Losses","Step Tool"]},"analysisFramework":{"type":"string","description":"Framework used in analysis.","enum":["ELT","PLT"],"example":"ELT"},"simulationSetId":{"type":"integer","description":"ID of <<glossary:simulation set>>.","format":"int32","example":70},"simulationPeriods":{"type":"integer","description":"Number of <glossary:simulation periods>> used to compute PLT.","format":"int32","example":800000},"exposureSetGuid":{"type":"string","description":"UUID of <<glossary:exposure set>>.","example":"d794da57-ed8f-4cb6-bd90-cab84c2c3071"},"uri":{"type":"string","description":"URI of analysis result.","example":"/platform/riskdata/v1/analyses/9384768"},"exposureResourceName":{"type":"string","description":"Name of exposure resource."},"thumbprint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20251024.57"},"additionalProperties":{"description":"Analysis result details. Properties returned vary depending on analysis type, analysis framework, engine, etc.  ","$ref":"#/components/schemas/AnalysisAdditionalProperty"},"variationId":{"type":"integer","description":"ID of variation.","example":8336303},"eventInfo":{"type":"object","description":"Information about event.","properties":{"eventDateBehavior":{"type":"string"},"eventDate":{"type":"string"}}},"entitlement":{"type":"string","description":"Entitlement of <<glossary:principle>> that produced analysis."},"securableUri":{"type":"string","description":"URI of <<glossary:securable>>.","example":"/platform/riskdata/v1/exposureSet/3933283"},"analysisUuid":{"type":"string","description":"UUID of analysis result.","example":"fd0012dd-a1ff-458f-89af-e09048e0ac18"},"appAnalysisId":{"type":"integer","format":"int64","description":"ID of analysis result in Risk Modeler/UnderwriteIQ application.","example":174580},"engineId":{"type":"integer","description":"ID of engine.","format":"int32","example":100},"statusId":{"type":"integer","description":"ID of analysis status.","format":"int32","example":102},"typeId":{"description":"ID of analysis type.","type":"integer","format":"int32","example":102},"perilCode":{"type":"string","description":"Code of peril.","example":"EQ"},"subPerilId":{"type":"integer","description":"ID of <<glossary:subperil>>.","format":"int32","example":512},"regionCode":{"type":"string","description":"Code of analysis region.","example":"NA"},"lossAmplificationId":{"type":"integer","description":"ID of <<glossary:loss amplification>>.","format":"int32","example":7},"modeId":{"type":"integer","description":"Mode of analysis.\n\nOne of `0` (Invalid), `1` (Expected), `2` (Distributed for DLM; Simulated for HD), `3` Percentile, `4` (Amount), `5` (Downloaded RDM).","format":"int32","enum":[0,1,2,3,4,5],"example":2},"insuranceTypeId":{"type":"integer","description":"ID of insurance type.","format":"int32","example":1},"vulnerabilityCurveId":{"type":"integer","description":"ID of <<glossary:vulnerability curve>> code.","format":"int32","example":0},"engineSubTypeCode":{"type":"string","description":"Subtype code of engine.","example":"SL"},"isMultiEvent":{"type":"boolean","example":false},"engineSubTypeId":{"type":"integer","description":"Subtype of engine.","format":"int32","example":2},"securableId":{"type":"integer","description":"ID of <<glossary:securable>>.","format":"int64","example":18415516},"securableType":{"type":"string","description":"Type of <<glossary:securable>>.","enum":["exposureSet","programSet","businessHierarchySet","shareSet"]},"resourceGroupId":{"type":"string","description":"UUID of <<glossary:resource group>> to which model job was allocated.\n\nReturned only if specified in `include` query parameter.","example":"dfbc3df7-a83e-4e84-8202-cb5978b8442a"},"tagIds":{"description":"List of tags to apply to this result.","type":"array","items":{"type":"integer","format":"int32"},"example":[56,57]}}},"SearchAnalysisResponse":{"type":"object","properties":{"analysisId":{"type":"integer","description":"ID of analysis result.","format":"int64","example":18415539},"analysisName":{"type":"string","description":"Name of analysis result.","example":"TestGroup"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","example":"2025-03-26T23:53:20"},"description":{"type":"string","description":"Description of analysis result.","example":""},"sourceRdmName":{"type":"string","example":""},"analysisRegroupType":{"type":"string","enum":["All","Not Required","Post perspectives","Recalculate reinsurance statistics","Recalculate treaty statistics","Reinsurance perspectives"]},"exposureResourceType":{"type":"string","description":"Type of exposure.","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"engineVersion":{"type":"string","description":"Version of model engine used in model profile. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL13","RL13.1","RL15","RL16","RL17","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24","PLTALM1.0","PLTGroup1.0","Unrecognized"]},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113},"exposureName":{"type":"string","description":"Name of exposure (EDM).","example":"RMS_RL18_Ref_TestData_EDM"},"jobId":{"type":"integer","description":"ID of job.","format":"int64","example":42379997},"jobGuid":{"type":"string","description":"UUID of job.","example":"b709c590-5c88-4be0-9d8b-bcd085fda98f"},"isGroup":{"type":"boolean","description":"If `true`, analysis result is an <<glossary:analysis group>>.","example":false},"modelProfile":{"description":"Model profile used for analysis identified by `id`, `code`, and `name`.","$ref":"#/components/schemas/ExposureValue"},"outputProfile":{"description":"Output profile used for analysis identified by `id`, `code`, and `name`.","$ref":"#/components/schemas/ExposureValue"},"engineType":{"type":"string","description":"Engine used to process model job.","example":"DLM","enum":["ALM","CEP","CEPGroup","DLM","DLMExpress","Group","HD","HydraDLMExpress","Invalid"]},"analysisStatus":{"type":"string","description":"Status of analysis.","enum":["Analyzed","Analyzed Intermediate","Error in Analyzing","Error in persisting","Finished IFG","Finished event determination","Finished writing losses","Invalid","Not analyzed","Running EP engine","Running IFG","Running event determination","Writing losses"]},"analysisType":{"type":"string","description":"Type of analysis.","enum":["Building Level","CA DOI","Exceedance Probability","Footprint File","Historical","Maximum Credible","Maximum Historical","Probabilistic Loss Over Time","Scenario","Specific Area","Spider","Spider-SDF","Terrorism - Simple Footprint","Terrorism - VRG Footprint","Unrecognized","User Defined"]},"peril":{"type":"string","description":"Name of primary peril causing loss.","enum":["Accumulation","Earthquake","Fire","Flood","Hurricane","Infectious Disease","Multi-Peril","Severe Convective Storm","Terrorism","Tornado","Unknown","Unrecognized","Wildfire","Windstorm","Winterstorm"]},"subPeril":{"type":"string","description":"Name of secondary peril.\n\nAdditional modeled peril associated with or caused by primary `peril` causing loss.","enum":["All","Fire + Shake + Sprinkler Leakage (EQSL)","Fire + Sprinkler Leakage (EQSL)","Fire Only","Flood Only","Freeze Only","Hail + Wind","Hail Only","Ice + Freeze","Ice Only","Multi-SubPeril","None","Off + On Plain Flood","Off Plain Flood Only","On Plain Flood Only","Shake + Fire","Shake + Sprinkler Leakage (EQSL)","Shake Only","Snow + Freese","Snow + Ice","Snow + Ice + Freeze","Snow Only","Sprinkler Leakage (EQSL) Only","Surge + Flood","Surge + Wind","Surge + Wind + Flood","Surge Only","Tornado + Hail","Tornado + Hail + Wind","Tornado + Wind","Tornado Only","WInd + Flood","Wind + Freeze","Wind + Ice","Wind + Snow","Wind + Snow + Freeze","Wind + Snow + Ice","Wind + Snow + Ice + Freeze","Wind Only"]},"region":{"type":"string","description":"Region of analysis.","example":"North Atlantic (including Hawaii)"},"lossAmplification":{"type":"string","enum":["BI","Building","Building, BI","Building, Contents","Building, Contents, BI","Contents","Contents, BI","Mixed","None","Not Applicable","Unknown"],"example":"Building, Contents, BI"},"analysisMode":{"type":"string","description":"Mode of analysis.","enum":["Amount","Distributed","Expected","Percent","Simulated","Unrecognized"],"example":"Distributed"},"insuranceType":{"type":"string","enum":["Property","Property, Workers Comp","Unknown","Workers Comp"],"example":"Property"},"vulnerabilityCurve":{"type":"string","description":"<<glossary:Vulnerability curve>> used in analysis.","enum":["Vulnerability - Default","First alternate set of curves","Second alternate set of curves","Third alternate set of curves"],"example":"Vulnerability - Default"},"username":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that ran analysis, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"eventRateSchemeNames":{"type":"array","items":{"$ref":"#/components/schemas/ExposureValue"}},"currency":{"$ref":"#/components/schemas/AnalysisCurrency"},"engineSubType":{"type":"string","description":"Subtype of engine.","enum":["Climate Change","Marginal Impact","Not Applicable","Simulated Losses","Step Tool"]},"analysisFramework":{"type":"string","description":"Framework used in analysis.","enum":["ELT","PLT"],"example":"ELT"},"simulationSetId":{"type":"integer","description":"ID of <<glossary:simulation set>>.","format":"int32","example":70},"simulationPeriods":{"type":"integer","description":"Number of <glossary:simulation periods>> used to compute PLT.","format":"int32","example":800000},"exposureSetGuid":{"type":"string","description":"UUID of <<glossary:exposure set>>.","example":"d794da57-ed8f-4cb6-bd90-cab84c2c3071"},"uri":{"type":"string","description":"URI of analysis result.","example":"/platform/riskdata/v1/analyses/9384768"},"exposureResourceName":{"type":"string","description":"Name of exposure resource."},"thumbprint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20251024.57"},"variationId":{"type":"integer","description":"ID of variation.","example":8336303},"eventInfo":{"type":"object","description":"Information about event.","properties":{"eventDateBehavior":{"type":"string"},"eventDate":{"type":"string"}}},"entitlement":{"type":"string","description":"Entitlement of <<glossary:principle>> that produced analysis."},"securableUri":{"type":"string","description":"URI of <<glossary:securable>>.","example":"/platform/riskdata/v1/exposureSet/3933283"},"analysisUuid":{"type":"string","description":"UUID of analysis result.","example":"fd0012dd-a1ff-458f-89af-e09048e0ac18"},"appAnalysisId":{"type":"integer","format":"int64","description":"ID of analysis result in Risk Modeler/UnderwriteIQ application.","example":174580},"engineId":{"type":"integer","description":"ID of engine.","format":"int32","example":100},"statusId":{"type":"integer","description":"ID of analysis status.","format":"int32","example":102},"typeId":{"description":"ID of analysis type.","type":"integer","format":"int32","example":102},"perilCode":{"type":"string","description":"Code of peril.","example":"EQ"},"subPerilId":{"type":"integer","description":"ID of <<glossary:subperil>>.","format":"int32","example":512},"regionCode":{"type":"string","description":"Code of analysis region.","example":"NA"},"lossAmplificationId":{"type":"integer","description":"ID of <<glossary:loss amplification>>.","format":"int32","example":7},"modeId":{"type":"integer","description":"Mode of analysis.\n\nOne of `0` (Invalid), `1` (Expected), `2` (Distributed for DLM; Simulated for HD), `3` Percentile, `4` (Amount), `5` (Downloaded RDM).","format":"int32","enum":[0,1,2,3,4,5],"example":2},"insuranceTypeId":{"type":"integer","description":"ID of insurance type.","format":"int32","example":1},"vulnerabilityCurveId":{"type":"integer","description":"ID of <<glossary:vulnerability curve>> code.","format":"int32","example":0},"engineSubTypeCode":{"type":"string","description":"Subtype code of engine.","example":"SL"},"isMultiEvent":{"type":"boolean","example":false},"engineSubTypeId":{"type":"integer","description":"Subtype of engine.","format":"int32","example":2},"securableId":{"type":"integer","description":"ID of <<glossary:securable>>.","format":"int64","example":18415516},"securableType":{"type":"string","description":"Type of <<glossary:securable>>.","enum":["exposureSet","programSet","businessHierarchySet","shareSet"]},"tagIds":{"description":"List of tags to apply to this result.","type":"array","items":{"type":"integer","format":"int32"},"example":[56,57]}}},"AnalysisCurrency":{"type":"object","properties":{"currencyName":{"type":"string","description":"Name of currency."},"currencyCode":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"USD"},"currencyScheme":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"HVC"},"currencyAsOfDate":{"type":"string","description":"Effective date of currency scheme in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`.","example":"2025-06-06T00:08:06.574Z"},"currencyVintage":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"HVC 18.1"}}},"AnalysisRegion":{"type":"object","properties":{"region":{"type":"string","description":"Region covered by the treaty, e.g. Austrailia, Caribbean, Centeral America, China \n\nSee [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)."},"subRegion":{"type":"string","description":"Subregion within the specified `region`, e.g. `Belgium` is a subregion within `EU`\n\nSee [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)"},"peril":{"description":"Natural or man-made phenomenon that generates insurance loss.","type":"string","example":"Earthquake","enum":["Accumulation","Earthquake","Fire","Flood","Hurricane","Infectious Disease","Multi-Peril","Severe Convective Storm","Terrorism","Tornado","Unknown","Unrecognized","Wildfire","Windstorm","Winterstorm"]},"eventRateSchemeId":{"type":"integer","format":"int32","description":"ID of <<glossary:event rate scheme>>.","example":67},"framework":{"type":"string","description":"Framework for grouping analyses.","example":"PLT","enum":["ELT","PLT"]},"analysisId":{"type":"integer","format":"int64","description":"ID of analysis."},"modelProfileId":{"type":"integer","format":"int32","description":"ID of <<glossary:model profile>>."},"petId":{"type":"integer","description":"ID of <<glossary:period loss table>>. A collection of simulated periods and the events simulated to occur within each period. Each period contains the same fixed number of years.","format":"int32"},"numSamples":{"description":"Number of times the ground up damage ratio is sampled from the severity distribution for each event ID. Appropriate number depends on number of buildings,  resolution of those buildings, and geographic distribution of the portfolio and events chosen for analysis.","type":"integer","format":"int32"},"periods":{"type":"integer","format":"int32"},"applyContractFlag":{"type":"boolean"},"engineVersion":{"type":"string","description":"Version of model engine used in model profile. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL13","RL13.1","RL15","RL16","RL17","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24","PLTALM1.0","PLTGroup1.0","Unrecognized"]}}},"UpdateAnalysisInfo":{"type":"object","properties":{"analysisName":{"maxLength":64,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string","description":"New name of analysis result. Valid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`).\n","example":"analysisName"}}},"DataTagEntity":{"type":"object","properties":{"tagIds":{"type":"array","description":"List of tags to apply to this analysis result. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"Branch":{"required":["branchName"],"type":"object","properties":{"branchId":{"type":"integer","format":"int32","readOnly":true,"description":"ID of branch.","example":22},"branchName":{"maxLength":30,"minLength":0,"type":"string","description":"Name of branch.","example":"London"},"uri":{"type":"string","readOnly":true,"example":"/platform/riskdata/v1/exposures/34/branches/22"}}},"Cedant":{"required":["cedantName"],"type":"object","properties":{"cedantId":{"maxLength":20,"minLength":0,"pattern":"^\\w([\\w-]*\\w|)$","type":"string","example":34},"cedantName":{"maxLength":40,"minLength":0,"type":"string","example":"Rena"},"uri":{"type":"string","readOnly":true,"example":"/platform/riskdata/v1/exposures/34/cedants/22"}}},"DataServer":{"type":"object","properties":{"serverName":{"type":"string","description":"Name of database server instance.","example":"EDM_West_Server"},"serverId":{"type":"integer","description":"ID of database server instance.","format":"int64","example":4},"serverType":{"type":"string","description":"Type of database server instance.","example":"PLATFORM","enum":["PLATFORM","DATA_BRIDGE"]},"totalDiskSpaceInMb":{"type":"string","description":"Disk space in MB.","example":2096128},"availableDiskSpaceInMb":{"type":"string","description":"Available disk space in MB.","example":1995111},"usedDiskSpaceInMb":{"type":"string","description":"Used disk space in MB.","example":101018}}},"DataBridgeDatabase":{"type":"object","properties":{"databaseId":{"type":"integer","description":"ID of database.","format":"int64"},"serverId":{"type":"integer","description":"ID of database server instance.","format":"int64"},"databaseName":{"type":"string","description":"Name of database."},"databaseType":{"type":"string","description":"Type of database."},"databaseVersion":{"type":"string","description":"Version of database."},"status":{"type":"string","description":"Status of database.","enum":["ACTIVE","INACTIVE"]}}},"IrpRegisterDatabridgeDatabaseInfo":{"type":"object","properties":{"exposureSetId":{"description":"ID of <<glossary:exposure set>> securable.","type":"integer","format":"int64"},"deferMetricCalculation":{"description":"If `true`, the EDM is registered without running time-consuming analysis jobs","type":"boolean"},"tagIds":{"description":"List of tags to apply to this exposure set. See [Tags](reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"Exposure":{"required":["exposureName","serverId"],"type":"object","properties":{"exposureName":{"description":"Name of exposure (EDM).","maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"exposureId":{"type":"integer","description":"ID of exposure (EDM).","format":"int64","readOnly":true},"uri":{"type":"string","description":"URI of exposure (EDM).","readOnly":true},"status":{"type":"string","description":"Status of exposure (EDM).","readOnly":true},"databaseName":{"type":"string","description":"Name of database.","readOnly":true},"metrics":{"type":"object","properties":{"dbsize_actual":{"type":"string","description":"Size of EDM database.","example":"79672"},"accountCount":{"type":"number","description":"Number of <<glossary:account>>s.","example":0},"size":{"type":"string","description":"Size of EDM in MB.","example":"77 MB"},"dataVersion":{"type":"string","description":"Data version of exposure data in EDM.","example":"21.0.0"},"edmVersion":{"type":"string","description":"Database schema version of EDM.","example":"25"},"cedantCount":{"type":"number","description":"Number of <<glossary:cedant>>s.","example":0},"locationCount":{"type":"number","description":"Number of <<glossary:location>>s.","example":0},"portfolioCount":{"type":"number","description":"Number of <<glossary:portfolio>>s.","example":0},"treatyCount":{"type":"number","description":"Number of <<glossary:treaties>>.","example":0},"aggregatedPortfolioCount":{"type":"number","description":"Number of <<glossary:aggregate portfolio>>s.","example":0},"lastModified":{"type":"string","description":"Date exposure (EDM) was last modified in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`.","example":"2026-03-30 21:00:14.00"}}},"ownerName":{"type":"string","description":"Name of owner.","readOnly":true},"exposureSetId":{"type":"integer","description":"ID of <<glossary:exposure set>>.","format":"int64","readOnly":true},"serverType":{"type":"string","description":"Type of <<glossary:data server>>.","readOnly":true,"enum":["PLATFORM","DATA_BRIDGE"]},"serverName":{"type":"string","description":"Name of data server.","readOnly":true},"serverId":{"description":"ID of data server.","minimum":1,"type":"integer","format":"int64"},"tagIds":{"description":"List of tags to apply to this exposure. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created exposure (EDM), e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@email.com"},"createdAt":{"type":"string","description":"Date exposure (EDM) was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z.","format":"date-time"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated exposure (EDM), e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"updatedAt":{"type":"string","description":"Date exposure (EDM) was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z.","format":"date-time"},"thumbprint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20251024.57"}}},"UpgradeExposureRequest":{"required":["edmDataVersion"],"type":"object","properties":{"edmDataVersion":{"type":"string","description":"Data version of exposure (EDM).","enum":[22],"example":22}}},"ExposureSet":{"required":["exposureSetName"],"type":"object","properties":{"exposureSetId":{"description":"User-defined name of exposure set. Should be unique.","type":"integer","format":"int64","readOnly":true},"guid":{"type":"string","description":"System-defined ID of expsoure set.","readOnly":true},"exposureSetName":{"maxLength":80,"minLength":1,"type":"string"},"ownerName":{"description":"Login of <<glossary:principal>> that owns exposure set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","type":"string","format":"email","example":"user.name@company.com","readOnly":true},"groups":{"description":"List of groups that can access child exposures. ","uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Group"}},"share":{"description":"If `true`, the specified `groupId`s may access the exposures in this exposure set.","type":"boolean","writeOnly":true}}},"ExposureVariation":{"type":"object","properties":{"exposureResourceUri":{"type":"string","description":"URI of exposure resource.","example":"/platform/riskdata/v1/exposures/3348807/portfolios/5"},"exposureResourceType":{"type":"string","description":"Type of exposure resource.","example":"portfolio","enum":["account","aggportfolio","portfolio"]},"exposureResourceNumber":{"type":"string","description":"ID number of exposure resource.","example":"AU_NRES"},"exposureResourceName":{"type":"string","description":"Name of exposure resource.","example":"CU_NRES_2025_PX"},"exposureName":{"type":"string","description":"Name of exposure.","example":"IED2025_CUCY_PX_CUD_EDM250"},"exposureId":{"type":"integer","description":"ID of exposure.","format":"int32","example":5},"exposureResourceId":{"description":"ID of exposure resource.","type":"integer","format":"int32","example":26113},"exposureVariationName":{"type":"string","description":"Name of exposure variation."},"exposureVariationId":{"type":"integer","description":"ID of exposure variation.","format":"int32","example":3351105},"createdAt":{"type":"string","format":"date-time","description":"Date exposure variation was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. 2020-01-01T00:00:00.000Z"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created exposure variation, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"stats":{"type":"object","description":"Number of account and location exposures attached to exposure variation.","properties":{"accountsCount":{"type":"integer","description":"Number of accounts attached to exposure variation.","format":"int32","example":12187},"policiesCount":{"type":"integer","description":"Number of pollicies attached to exposure varation.","format":"int32","example":12187},"locationsCount":{"description":"Number of locations attached to exposure variation.","type":"integer","format":"int32","example":53879}}},"exposureSetId":{"type":"integer","description":"ID of <<glossary:exposure set>>.","format":"int32"},"currency":{"type":"object","description":"Currency used in modeling of exposure variation.","properties":{"currencySchemeName":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"RMS"},"currencyCode":{"type":"string","description":"Code that identifies default currency used to calculate losses. Corresponds to a value in the specified currency scheme (`scheme`). If RMS Currency Scheme, conforms to [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) standard.","example":"CAD"},"currencyVintageName":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`)."}}},"accumulationCompatible":{"type":"boolean","description":"If exposure variation is compatible to run accumulation job, `true`. ","example":true},"perils":{"type":"array","description":"List of perils, natural or man-made phenomenon that generates insurance loss. Includes `CS/WT` (Severe Convective Storm and Winterstorm), `EQ` (Earthquake), `FL` (Flood), `FR` (Fire), `TR` (Terrorism), `WC` (Workers Compensation), `WS` (Windstorm).","items":{"type":"string"},"example":["WI","WA"]},"tiv":{"type":"number","format":"double","description":"Replacment cost (total insurable value) of <<glossary:location coverage>> values for buildings, building contents, and business interruptions at location."},"uri":{"type":"string","description":"URI of exposure variation.","example":"/platform/riskdata/v1/exposurevariations/3289794"},"thumbprint":{"type":"string","description":"Build number of Intelligent Risk Platform.","example":"EUW1.20251024.57","readOnly":true},"version":{"type":"string","description":"Version of exposure variation. \n\n- If `1`, can be used to compute accumulations.\n- If `2`, can be used to compute accumulations, ALM, DLM, and HD analysis.","enum":["1","2"]},"fileSizeInBytes":{"type":"integer","format":"int64","description":"Size of exposure variation file in bytes. Only available for version 2 exposure variations.","example":2768069}}},"Group":{"type":"object","properties":{"groupId":{"type":"string"},"groupName":{"type":"string","readOnly":true}}},"PatchExposureSetRequest":{"required":["operation","targetProperty","value"],"type":"object","properties":{"operation":{"description":"Change to exposure set. `ADD` or `REMOVE` a `groupId` to change access rights. `UPDATE` the `exposureSetName` to rename this exposure set.","type":"string","enum":["ADD","UPDATE","REMOVE","COPY","IMPORT"]},"targetProperty":{"description":"Exposure set property to update.","type":"string","enum":["exposureSetName","groupId"]},"value":{"description":"Updated value of exposure set property.","maxLength":80,"minLength":0,"type":"string"}}},"Facultative":{"required":["facultativeId","facultativeName"],"type":"object","properties":{"facultativeId":{"maxLength":20,"minLength":0,"pattern":"^\\w([\\w-]*\\w|)$","type":"string"},"facultativeName":{"maxLength":40,"minLength":0,"type":"string"},"uri":{"type":"string","readOnly":true}}},"ArithmeticExpression":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"expression":{"$ref":"#/components/schemas/Expression"},"arithmeticPairs":{"type":"array","items":{"$ref":"#/components/schemas/ArithmeticPair"}}}}]},"ArithmeticPair":{"type":"object","properties":{"operator":{"type":"string","enum":["ADD","SUBTRACT","MULTIPLY","DIVIDE"]},"expression":{"$ref":"#/components/schemas/Expression"}}},"Assignment":{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/Identifier"},"operator":{"type":"string","enum":["EQUAL","ADD","SUBTRACT","MULTIPLY","DIVIDE"]},"expression":{"$ref":"#/components/schemas/Expression"}}},"BooleanCondition":{"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"condition":{"$ref":"#/components/schemas/Condition"},"booleanPairs":{"type":"array","items":{"$ref":"#/components/schemas/BooleanPair"}}}}]},"BooleanPair":{"type":"object","properties":{"operator":{"type":"string","enum":["AND","OR"]},"condition":{"$ref":"#/components/schemas/Condition"}}},"BooleanValue":{"type":"string","allOf":[{"$ref":"#/components/schemas/Expression"}],"enum":["true","false"]},"ChildIdentifier":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"name":{"type":"string"},"columnName":{"type":"string"},"tableName":{"type":"string"},"dbType":{"type":"string","writeOnly":true,"enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"castTo":{"type":"string","enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"clearDataResolution":{"type":"boolean"},"dataResolutionUS":{"type":"boolean"},"validation":{"type":"string"},"filterable":{"type":"boolean"},"skipSecondary":{"type":"boolean"},"foreignKeyColumnName":{"type":"string"},"subqueryTableName":{"type":"string"},"subqueryIdentifier":{"$ref":"#/components/schemas/Identifier"}}}]},"Condition":{"required":["type"],"type":"object","properties":{"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"DateOnlyValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"year":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"dayOfMonth":{"type":"integer","format":"int32"}}}]},"DecimalValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"value":{"type":"number"}}}]},"Expression":{"required":["type"],"type":"object","properties":{"dataType":{"type":"string","enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"ForeignKeyIdentifier":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"name":{"type":"string"},"columnName":{"type":"string"},"tableName":{"type":"string"},"dbType":{"type":"string","writeOnly":true,"enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"castTo":{"type":"string","enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"clearDataResolution":{"type":"boolean"},"dataResolutionUS":{"type":"boolean"},"validation":{"type":"string"},"filterable":{"type":"boolean"},"skipSecondary":{"type":"boolean"},"primaryKeyColumnName":{"type":"string"},"subqueryIdentifier":{"$ref":"#/components/schemas/Identifier"}}}]},"Identifier":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"name":{"type":"string"},"columnName":{"type":"string"},"tableName":{"type":"string"},"dbType":{"type":"string","writeOnly":true,"enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"castTo":{"type":"string","enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"clearDataResolution":{"type":"boolean"},"dataResolutionUS":{"type":"boolean"},"validation":{"type":"string"},"filterable":{"type":"boolean"},"skipSecondary":{"type":"boolean"}}}]},"InListCondition":{"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/Identifier"},"not":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ValueObject"}}}}]},"IntegerValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"value":{"type":"integer","format":"int32"}}}]},"BulkEdit":{"required":["exposureResourceId","exposureResourceType"],"type":"object","properties":{"exposureResourceId":{"description":"ID of analyzed exposure resource.","minimum":1,"type":"integer","format":"int32","example":26113},"editType":{"type":"string"},"editQuery":{"type":"string"},"exposureResourceType":{"type":"string","enum":["ACCOUNT","AGGPORTFOLIO","LOCATION","POLICY","PORTFOLIO","STEP_POLICY","TREATY","UNRECOGNIZED"]},"editCondition":{"$ref":"#/components/schemas/Condition"},"updates":{"type":"array","items":{"type":"string"}},"updateConditions":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"}},"outputClause":{"type":"string"},"advanced":{"type":"boolean"}}},"LongValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"value":{"type":"integer","format":"int64"}}}]},"MatchingCondition":{"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/Identifier"},"not":{"type":"boolean"},"pattern":{"type":"string"}}}]},"NullValue":{"type":"string","allOf":[{"$ref":"#/components/schemas/Expression"}],"enum":["NULL"]},"RelationalCondition":{"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/Identifier"},"operator":{"type":"string","enum":["EQUAL","NOT_EQUAL","LESS_THAN","GREATER_THAN","LTE","GTE"]},"expression":{"$ref":"#/components/schemas/Expression"}}}]},"StringValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"value":{"type":"string"}}}]},"SubqueryCondition":{"type":"object","allOf":[{"$ref":"#/components/schemas/Condition"},{"type":"object","properties":{"identifier":{"$ref":"#/components/schemas/Identifier"},"columnName":{"type":"string"},"tableName":{"type":"string"},"conditionColumnName":{"type":"string"},"conditionValue":{"type":"string"}}}]},"TimestampValue":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"epochSeconds":{"type":"integer","format":"int64"}}}]},"ValueObject":{"type":"object","properties":{"value":{"type":"object"}}},"YearBuiltIdentifier":{"type":"object","allOf":[{"$ref":"#/components/schemas/Expression"},{"type":"object","properties":{"name":{"type":"string"},"columnName":{"type":"string"},"tableName":{"type":"string"},"validation":{"type":"string"},"dbType":{"type":"string","writeOnly":true,"enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"castTo":{"type":"string","enum":["INTEGER","STRING","STATUS","LIST","TIMESTAMP","OPERATOR","STATUS_ICON","LINK","FLOAT","BOOLEAN","DATE_ONLY","PERCENT","OBJECT","LONG","NULL"]},"clearDataResolution":{"type":"boolean"},"dataResolutionUS":{"type":"boolean"},"filterable":{"type":"boolean"},"skipSecondary":{"type":"boolean"}}}]},"LineOfBusiness":{"required":["lobName"],"type":"object","properties":{"lobId":{"type":"integer","format":"int32","readOnly":true},"lobName":{"description":"Name of line of business.","example":"FACTORY","maxLength":20,"minLength":0,"type":"string"},"uri":{"type":"string","readOnly":true}}},"BuildingAttribute":{"required":["yearBuilt"],"type":"object","properties":{"buildingAttributeId":{"type":"integer","format":"int32","readOnly":true},"yearBuilt":{"type":"string","format":"yyyy","example":"2020"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"roofDeckType":{"$ref":"#/components/schemas/ExposureValue"},"roofDeckResistanceField":{"type":"number","format":"double"},"windowGlassdoorProtectionType":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorThickness":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorDoublepane":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorProtectionAdequacy":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverType":{"$ref":"#/components/schemas/ExposureValue"},"rooftopEquipment":{"$ref":"#/components/schemas/ExposureValue"},"skylightAreaPercent":{"type":"number","format":"double"},"dockDoorAreaPercent":{"type":"number","format":"double"},"dockDoorPressureResistance":{"type":"number","format":"double"},"skylightImpactResistance":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverResistanceCorner":{"type":"number","format":"double"},"roofSlope":{"$ref":"#/components/schemas/ExposureValue"},"flashingPulloutResistance":{"type":"number","format":"double"},"missileExposure":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverResistancePerimeter":{"type":"number","format":"double"},"roofDeckResistancePerimeter":{"type":"number","format":"double"},"claddingPressureResistance":{"type":"number","format":"double"},"windowGlassdoorGlassType":{"$ref":"#/components/schemas/ExposureValue"},"claddingType":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorAreaPercent":{"type":"number","format":"double"},"roofDeckResistanceCorner":{"type":"number","format":"double"},"roofCoverResistanceField":{"type":"number","format":"double"},"roofArea":{"type":"number","format":"double"},"uri":{"type":"string","readOnly":true}}},"Address":{"type":"object","properties":{"addressId":{"type":"integer","format":"int32","readOnly":true},"area":{"$ref":"#/components/schemas/ExposureValue"},"buildingId":{"type":"string"},"buildingName":{"type":"string"},"addressType":{"$ref":"#/components/schemas/ExposureValue"},"country":{"$ref":"#/components/schemas/ExposureValue"},"countryScheme":{"type":"string"},"countryGeoId":{"type":"integer","format":"int32"},"countryRmsCode":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"addressText":{"type":"string"},"streetAddress":{"type":"string"},"cityCode":{"type":"string"},"cityName":{"type":"string"},"cityGeoId":{"type":"integer","format":"int64"},"postalCode":{"type":"string"},"postalGeoId":{"type":"integer","format":"int64"},"block":{"type":"string"},"blockGroup":{"type":"string"},"locationCode":{"type":"string"},"locationCodeGeoId":{"type":"integer","format":"int64"},"parcelNumber":{"type":"string"},"subLocality":{"type":"string"},"geoResolutionConfidence":{"type":"number","format":"double"},"geoAccuracyBuffer":{"type":"number","format":"double"},"geoProductVersion":{"type":"string"},"geoLocationCode":{"type":"string"},"geoMatchCode":{"type":"string"},"geoDataSourceId":{"type":"integer","format":"int32"},"geoResolutionCode":{"$ref":"#/components/schemas/ExposureValue"},"geoDataSourceVersionId":{"type":"integer","format":"int32"},"geoDateTime":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"createDateTime":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"},"updateDateTime":{"type":"string"},"admin1Code":{"type":"string"},"admin1GeoId":{"type":"integer","format":"int64"},"admin1Name":{"type":"string"},"admin2Code":{"type":"string"},"admin2GeoId":{"type":"integer","format":"int64"},"admin2Name":{"type":"string"},"admin3Code":{"type":"string"},"admin3GeoId":{"type":"integer","format":"int64"},"admin3Name":{"type":"string"},"admin4Code":{"type":"string"},"admin4GeoId":{"type":"integer","format":"int64"},"admin4Name":{"type":"string"},"admin5Code":{"type":"string"},"admin5GeoId":{"type":"integer","format":"int64"},"admin5Name":{"type":"string"},"zone1GeoId":{"type":"integer","format":"int64"},"zone2GeoId":{"type":"integer","format":"int64"},"zone3GeoId":{"type":"integer","format":"int64"},"zone4GeoId":{"type":"integer","format":"int64"},"zone5GeoId":{"type":"integer","format":"int64"},"zone1":{"type":"string"},"zone2":{"type":"string"},"zone3":{"type":"string"},"zone3Name":{"type":"string"},"zone4Name":{"type":"string"},"zone5Name":{"type":"string"},"zone3Code":{"type":"string"},"zone4Code":{"type":"string"},"zone5Code":{"type":"string"},"ugid":{"type":"string"}}},"Location":{"required":["address","property"],"type":"object","properties":{"property":{"$ref":"#/components/schemas/Property"},"address":{"$ref":"#/components/schemas/Address"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"tiv":{"type":"number","format":"double","description":"Replacment cost (total insurable value) of <<glossary:location coverage>> values for buildings, building contents, and business interruptions at location."},"riskAssessorCurves":{"type":"string"},"maxCvgBldgValuation":{"type":"number","format":"double"},"uri":{"type":"string","readOnly":true}}},"Property":{"required":["expireDate","inceptDate","locationNumber","yearBuilt"],"type":"object","properties":{"accountId":{"description":"ID of account.","type":"integer","format":"int32"},"locationId":{"description":"ID of location.","type":"integer","format":"int32"},"addressId":{"description":"ID of address.","type":"integer","format":"int32"},"locationNumber":{"description":"Number of location.","type":"string"},"locationName":{"type":"string"},"contentLossTrigger":{"type":"string","enum":["NO","YES"]},"userId1":{"type":"string","description":"User-defined ID."},"userId2":{"type":"string","description":"User-defined ID."},"userText1":{"type":"string","description":"User-defined note."},"userText2":{"type":"string","description":"User-defined note."},"expireDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"inceptDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"yearBuilt":{"type":"string","format":"yyyy","example":"2020"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"updateDate":{"type":"string","readOnly":true},"buildingClassScheme":{"$ref":"#/components/schemas/ExposureValue"},"buildingClass":{"$ref":"#/components/schemas/ExposureValue"},"occupancyTypeScheme":{"$ref":"#/components/schemas/ExposureValue"},"occupancyType":{"$ref":"#/components/schemas/ExposureValue"},"primaryLocId":{"type":"integer","format":"int32"},"siteName":{"$ref":"#/components/schemas/ExposureValue"},"buildings":{"type":"integer","format":"int32"},"stories":{"type":"integer","format":"int32"},"floorOccupancy":{"type":"string"},"floorArea":{"type":"number","format":"double"},"bldgHeight":{"type":"number","format":"double"},"heightUnit":{"$ref":"#/components/schemas/ExposureValue"},"slope":{"type":"number","format":"double"},"otherZone":{"type":"string"},"huZone":{"$ref":"#/components/schemas/ExposureValue"},"areaUnit":{"$ref":"#/components/schemas/ExposureValue"},"bldgValuation":{"type":"number","format":"double"},"valuationDiffAmt":{"type":"number","format":"double"},"valuationDiffPercent":{"type":"number","format":"double"},"useContentValue":{"$ref":"#/components/schemas/ExposureValue"},"floodDefenseElevation":{"type":"number","format":"double"},"floodDefenseElevationUnit":{"$ref":"#/components/schemas/ExposureValue"},"rentalPropertyIdentifier":{"$ref":"#/components/schemas/ExposureValue"},"mfdSubcategory":{"$ref":"#/components/schemas/ExposureValue"},"dwellTime":{"type":"integer","format":"int32"},"nship":{"type":"integer","format":"int32"},"userGroundElev":{"type":"number","format":"double"},"userBfe":{"type":"number","format":"double"},"floodDefHtAboveGrnd":{"type":"number","format":"double"},"roofYear":{"type":"integer","format":"int32"},"capacity":{"type":"number","format":"float"},"isPrimaryBldg":{"type":"boolean"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."}}},"LocationBiDetail":{"type":"object","properties":{"locationBiDetailId":{"type":"integer","format":"int32","readOnly":true},"redundancy":{"$ref":"#/components/schemas/ExposureValue"},"siWaitingPeriod":{"type":"number","format":"double"},"siLimit":{"type":"number","format":"double"},"preparedness":{"$ref":"#/components/schemas/ExposureValue"},"serviceInterruption":{"$ref":"#/components/schemas/ExposureValue"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true}}},"LocationCondition":{"type":"object","properties":{"locationId":{"description":"ID of location.","type":"integer","format":"int32"},"conditionId":{"description":"ID of policy condition.","type":"integer","format":"int32"},"isIncluded":{"description":"Method of applying policy condition to location.\n\n- If `Included` policy condition applies to location.\n- If `NotIncluded`, policy condition does not apply to location.\n- If `UserIncluded`, policy condition is applied to location based on criteria or user input.","type":"string","enum":["NotIncluded","Included","UserIncluded"]}}},"LocationCoverage":{"type":"object","properties":{"waitingPeriod":{"type":"number","description":"BI waiting period; only applicable to BI coverage. Captured in number of days. Uses only single decimal place. By default, _0.0_.","format":"double"},"coverageId":{"type":"integer","description":"ID of location coverage.","format":"int32","readOnly":true},"label":{"description":"Label identified by `id`, `code`, and `name`.\n\n| `id` | `code` | `name`       |\n| ---- | ------ | ------------ |\n| 7    | EQ     | Building     |\n| 8    | EQ     | Contents     |\n| 9    | EQ     | BI           |\n| 28   | EQ     | Coverage A   |\n| 29   | EQ     | Coverage B   |\n| 30   | EQ     | Coverage C   |\n| 31   | EQ     | Coverage D   |\n| 50   | EQ     | Combined Cvg |\n| 14   | WS     | Building     |\n| 15   | WS     | Contents     |\n| 16   | WS     | BI           |\n| 24   | WS     | Coverage A   |\n| 25   | WS     | Coverage B   |\n| 26   | WS     | Coverage C   |\n| 27   | WS     | Coverage D   |\n| 51   | WS     | Combined Cvg |\n| 1    | TO     | Building     |\n| 10   | TR     | Building     |\n| 11   | TR     | Contents     |\n| 12   | TR     | BI           |\n| 44   | TR     | Coverage A   |\n| 45   | TR     | Coverage B   |\n| 46   | TR     | Coverage C   |\n| 47   | TR     | Coverage D   |\n| 55   | TR     | Combined Cvg |\n| 2    | TO     | Contents     |\n| 3    | TO     | BI           |\n| 32   | TO     | Coverage A   |\n| 33   | TO     | Coverage B   |\n| 34   | TO     | Coverage C   |\n| 35   | TO     | Coverage D   |\n| 52   | TO     | Combined Cvg |\n| 20   | FL     | Building     |\n| 21   | FL     | Contents     |\n| 22   | FL     | BI           |\n| 36   | FL     | Coverage A   |\n| 37   | FL     | Coverage B   |\n| 38   | FL     | Coverage C   |\n| 39   | FL     | Coverage D   |\n| 53   | FL     | Combined Cvg |\n| 4    | FR     | Building     |\n| 5    | FR     | Contents     |\n| 6    | FR     | B.I.         |\n| 40   | FR     | Coverage A   |\n| 41   | FR     | Coverage B   |\n| 42   | FR     | Coverage C   |\n| 43   | FR     | Coverage D   |\n| 54   | FR     | Combined Cvg |","$ref":"#/components/schemas/ExposureValue"},"eqslModifier":{"type":"integer","description":"Contents covered by EQSL (earthquake sprinkler leakage) subperil.","format":"int32"},"lossType":{"type":"string","description":"Type of loss.","enum":["BI","Building","CombinedCvg","Contents"]},"percentSprinkler":{"type":"number","description":"Percentage of contents under sprinkler.","format":"double"},"value":{"type":"number","format":"double"},"biPoi":{"type":"number","description":"BI period of indemnity. Not used in loss calculations.\n\nCaptured in number of months. Uses only a single decimal place. By default, `12.0`. ","format":"double"},"deductible":{"type":"number","description":"Amount of deductible.","format":"double"},"nonRankingDeductibleAmt":{"type":"number","description":"Value of deductible amount not applied to policy-level aggregate deductibles. ","format":"double"},"coverageModifier":{"type":"string","description":"Rating of content fragility; relevant to earthquakes (e.g. potential for building collapse).","enum":["DAMAGEABLE","HIGHLY_DAMAGEABLE","MODERATELY_DAMAGEABLE","SLIGHTLY_DAMAGEABLE","UNKNOWN_DAMAGEABLE"]},"accumulation":{"type":"string","description":"Type of accumulation.","enum":["Bi","Building","Combined","Contents"]},"limit":{"type":"number","format":"double","description":"Amount of limit."},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss.","enum":["EARTHQUAKE","FIRE","FLOOD","TERRORISM","TORNADO","WINDSTORM","WORKERSCOMP"]},"percentageLossDeductibleAmount":{"type":"number","description":"Deductible expressed as percentage of loss for coverage or combination of coverages. As loss increases, the deductible amount increases. Used to run HD models and accumulations.","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","enum":["YES","NO"]},"limitExtension":{"type":"number","format":"double","description":"Extent of law and ordinance coverage.\n\n- Used by US hurricane regions for informational purposes only. Not used in any loss calculations.\n- Used for financial model calculations in the North America Wildfire HD Models and Australia Bushfire HD Model."},"uri":{"type":"string","readOnly":true},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's. "}}},"LocationEqDetail":{"required":["completionDate","startDate","yearSprinkler","yearUpgrade"],"type":"object","properties":{"locationEqDetailId":{"type":"integer","format":"int32","readOnly":true},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"yearSprinkler":{"type":"string","format":"yyyy","example":"2020"},"percentComplete":{"type":"number","format":"double"},"atcClass":{"type":"string"},"isoClass":{"type":"string"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"sicOccupancy":{"type":"string"},"ibcOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"eqslInsurance":{"$ref":"#/components/schemas/ExposureValue"},"secondarySupply":{"$ref":"#/components/schemas/ExposureValue"},"eqslSusceptibility":{"$ref":"#/components/schemas/ExposureValue"},"sprinklerType":{"$ref":"#/components/schemas/ExposureValue"},"baseIsolation":{"$ref":"#/components/schemas/ExposureValue"},"bldgExterior":{"$ref":"#/components/schemas/ExposureValue"},"cladding":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"ductility":{"$ref":"#/components/schemas/ExposureValue"},"duress":{"$ref":"#/components/schemas/ExposureValue"},"enggFoundation":{"$ref":"#/components/schemas/ExposureValue"},"frameBolt":{"$ref":"#/components/schemas/ExposureValue"},"hazardExposed":{"$ref":"#/components/schemas/ExposureValue"},"internalMasonaryPart":{"$ref":"#/components/schemas/ExposureValue"},"longSpan":{"$ref":"#/components/schemas/ExposureValue"},"mechElecEquip":{"$ref":"#/components/schemas/ExposureValue"},"ornamentation":{"$ref":"#/components/schemas/ExposureValue"},"overhangProfile":{"$ref":"#/components/schemas/ExposureValue"},"preFabrication":{"$ref":"#/components/schemas/ExposureValue"},"pounding":{"$ref":"#/components/schemas/ExposureValue"},"redundancy":{"$ref":"#/components/schemas/ExposureValue"},"shapeConfigure":{"$ref":"#/components/schemas/ExposureValue"},"shortColumn":{"$ref":"#/components/schemas/ExposureValue"},"sidingType":{"$ref":"#/components/schemas/ExposureValue"},"storyProfile":{"$ref":"#/components/schemas/ExposureValue"},"structureUpgrade":{"$ref":"#/components/schemas/ExposureValue"},"tank":{"$ref":"#/components/schemas/ExposureValue"},"tiltupRetrofit":{"$ref":"#/components/schemas/ExposureValue"},"torsion":{"$ref":"#/components/schemas/ExposureValue"},"urmRetrofit":{"$ref":"#/components/schemas/ExposureValue"},"wallsBrace":{"$ref":"#/components/schemas/ExposureValue"},"tsDebris":{"$ref":"#/components/schemas/ExposureValue"},"tsScour":{"$ref":"#/components/schemas/ExposureValue"},"tsSafeDist":{"$ref":"#/components/schemas/ExposureValue"},"tsProtect":{"$ref":"#/components/schemas/ExposureValue"},"eqPackage":{"$ref":"#/components/schemas/ExposureValue"},"eqProtect":{"$ref":"#/components/schemas/ExposureValue"},"eqSalvage":{"$ref":"#/components/schemas/ExposureValue"},"eqSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"urmChimney":{"$ref":"#/components/schemas/ExposureValue"},"builtOnSlope":{"$ref":"#/components/schemas/ExposureValue"},"alquistPreoloZone":{"type":"integer","format":"int32"},"soil":{"type":"number","format":"double"},"landslide":{"type":"number","format":"double"},"liquefaction":{"type":"number","format":"double"},"biZone":{"type":"integer","format":"int32"},"landslideMatch":{"$ref":"#/components/schemas/ExposureValue"},"liquefactionMatch":{"$ref":"#/components/schemas/ExposureValue"},"soilMatch":{"$ref":"#/components/schemas/ExposureValue"},"fireLossMatch":{"$ref":"#/components/schemas/ExposureValue"},"landslideCov":{"type":"number","format":"double"},"liquefactionCov":{"type":"number","format":"double"},"soilCov":{"type":"number","format":"double"},"fireLossCov":{"type":"number","format":"float","readOnly":true},"soilPeriod":{"type":"number","format":"double"},"soilThickness":{"type":"number","format":"double"},"fire1":{"type":"number","format":"double"},"fire2":{"type":"number","format":"double"},"fire3":{"type":"number","format":"double"},"fire4":{"type":"number","format":"double"},"fire5":{"type":"number","format":"double"},"fire6":{"type":"number","format":"double"},"fire7":{"type":"number","format":"double"},"fire8":{"type":"number","format":"double"},"mmi100":{"type":"number","format":"double"},"mmi200":{"type":"number","format":"double"},"mmi250":{"type":"number","format":"double"},"mmi475":{"type":"number","format":"double"},"avgSlope":{"type":"number","format":"double"},"distFault1":{"type":"number","format":"double"},"apMatch":{"$ref":"#/components/schemas/ExposureValue"},"mmiMatch":{"$ref":"#/components/schemas/ExposureValue"},"distSinkhole":{"type":"number","format":"double"},"distMine":{"type":"number","format":"double"},"sinkholeZone":{"type":"integer","format":"int32"},"soilVs":{"type":"number","format":"double"},"soilVsMatch":{"$ref":"#/components/schemas/ExposureValue"},"basinLocId":{"type":"integer","format":"int32"},"di":{"type":"number","format":"double"},"critd":{"type":"number","format":"double"},"n160CS":{"type":"number","format":"double"},"t15":{"type":"number","format":"double"},"wff":{"type":"number","format":"double"},"distriv":{"type":"number","format":"double"},"gwd":{"type":"number","format":"double"},"dc":{"type":"number","format":"double"},"liqcv":{"type":"number","format":"double"},"hdLiqMatch":{"$ref":"#/components/schemas/ExposureValue"},"phi":{"type":"number","format":"double"},"rough":{"type":"number","format":"double"},"ndvi":{"type":"number","format":"double"},"cohes":{"type":"number","format":"double"},"landcv":{"type":"number","format":"double"},"hdLandMatch":{"$ref":"#/components/schemas/ExposureValue"},"eqSlope":{"type":"number","format":"double"},"elev":{"type":"number","format":"double"},"cti":{"type":"number","format":"double"},"precip":{"type":"number","format":"double"},"topo":{"type":"number","format":"double"},"hdSecMatch":{"$ref":"#/components/schemas/ExposureValue"},"soilPeriodMatch":{"$ref":"#/components/schemas/ExposureValue"},"groundwaterDepthMatch":{"$ref":"#/components/schemas/ExposureValue"},"groundSlopeMatch":{"$ref":"#/components/schemas/ExposureValue"},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"mmi500":{"type":"number","format":"double","readOnly":true},"mmi1000":{"type":"number","format":"double","readOnly":true},"mmi1500":{"type":"number","format":"double","readOnly":true},"faultsName1":{"type":"string","readOnly":true},"faultsDistance1":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM601":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM651":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM701":{"type":"integer","format":"int32","readOnly":true},"faultsName2":{"type":"string","readOnly":true},"faultsDistance2":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM602":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM652":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM702":{"type":"integer","format":"int32","readOnly":true},"faultsName3":{"type":"string","readOnly":true},"faultsDistance3":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM603":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM653":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM703":{"type":"integer","format":"int32","readOnly":true},"faultsName4":{"type":"string","readOnly":true},"faultsDistance4":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM604":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM654":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM704":{"type":"integer","format":"int32","readOnly":true},"faultsName5":{"type":"string","readOnly":true},"faultsDistance5":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM605":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM655":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM705":{"type":"integer","format":"int32","readOnly":true},"faultsBackgroundRates":{"type":"string","readOnly":true},"mineName1":{"type":"string","readOnly":true},"mineType1":{"type":"string","readOnly":true},"mineStatus1":{"type":"string","readOnly":true},"mineArea1":{"type":"number","format":"double","readOnly":true},"mineDistance1":{"type":"number","format":"double","readOnly":true},"mineName2":{"type":"string","readOnly":true},"mineType2":{"type":"string","readOnly":true},"mineStatus2":{"type":"string","readOnly":true},"mineArea2":{"type":"number","format":"double","readOnly":true},"mineDistance2":{"type":"number","format":"double","readOnly":true},"mineName3":{"type":"string","readOnly":true},"mineType3":{"type":"string","readOnly":true},"mineStatus3":{"type":"string","readOnly":true},"mineArea3":{"type":"number","format":"double","readOnly":true},"mineDistance3":{"type":"number","format":"double","readOnly":true},"mineName4":{"type":"string","readOnly":true},"mineType4":{"type":"string","readOnly":true},"mineStatus4":{"type":"string","readOnly":true},"mineArea4":{"type":"number","format":"double","readOnly":true},"mineDistance4":{"type":"number","format":"double","readOnly":true},"mineName5":{"type":"string","readOnly":true},"mineType5":{"type":"string","readOnly":true},"mineStatus5":{"type":"string","readOnly":true},"mineArea5":{"type":"number","format":"double","readOnly":true},"mineDistance5":{"type":"number","format":"double","readOnly":true},"sinkHoleArea1":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance1":{"type":"number","format":"double","readOnly":true},"sinkHoleArea2":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance2":{"type":"number","format":"double","readOnly":true},"sinkHoleArea3":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance3":{"type":"number","format":"double","readOnly":true},"sinkHoleArea4":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance4":{"type":"number","format":"double","readOnly":true},"sinkHoleArea5":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance5":{"type":"number","format":"double","readOnly":true},"uri":{"type":"string","readOnly":true}}},"LocationFlDetail":{"required":["completionDate","panelDate","startDate","yearUpgrade"],"type":"object","properties":{"locationFlDetailId":{"type":"integer","format":"int32","readOnly":true},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"floodProtect":{"$ref":"#/components/schemas/ExposureValue"},"floorType":{"$ref":"#/components/schemas/ExposureValue"},"floodMissile":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"duration":{"$ref":"#/components/schemas/ExposureValue"},"contamination":{"$ref":"#/components/schemas/ExposureValue"},"velocity":{"$ref":"#/components/schemas/ExposureValue"},"flPackage":{"$ref":"#/components/schemas/ExposureValue"},"flProtect":{"$ref":"#/components/schemas/ExposureValue"},"flSalvage":{"$ref":"#/components/schemas/ExposureValue"},"flSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"ifmVerticalExpDist":{"$ref":"#/components/schemas/ExposureValue"},"flFoundationType":{"$ref":"#/components/schemas/ExposureValue"},"ifmStructureCondition":{"$ref":"#/components/schemas/ExposureValue"},"bespokeFloodDefenseLevel":{"type":"number","format":"double"},"bespokeFloodDefenseLevelType":{"$ref":"#/components/schemas/ExposureValue"},"floodIndex":{"type":"number","format":"double"},"elevation":{"type":"number","format":"double"},"elevationCov":{"type":"number","format":"double"},"annProb":{"type":"string"},"flZone":{"type":"string"},"bfe":{"type":"string"},"additionalInfo":{"type":"string"},"panel":{"type":"string"},"cobra":{"type":"string"},"floodWay":{"type":"string"},"sfha":{"type":"string"},"community":{"type":"string"},"confidence":{"type":"number","format":"double"},"underRev":{"type":"string"},"panelDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"buffer":{"type":"number","format":"double"},"otherZones":{"type":"string"},"huZones":{"type":"string","readOnly":true},"mapSource":{"type":"integer","format":"int32"},"flMatch":{"$ref":"#/components/schemas/ExposureValue"},"finishedFloor":{"type":"number","format":"double"},"userId1":{"type":"string"},"userId2":{"type":"string"},"basinName":{"type":"string"},"catchmentId":{"type":"integer","format":"int32"},"floodDriver":{"type":"string"},"rms100Flzone":{"type":"integer","format":"int32"},"rms500Flzone":{"type":"integer","format":"int32"},"fl30YrRpDef":{"type":"integer","format":"int32"},"fl50YrRpDef":{"type":"integer","format":"int32"},"fl75YrRpDef":{"type":"integer","format":"int32"},"fl100YrRpDef":{"type":"integer","format":"int32"},"fl200YrRpDef":{"type":"integer","format":"int32"},"fl250YrRpDef":{"type":"integer","format":"int32"},"fl500YrRpDef":{"type":"integer","format":"int32"},"fl1000YrRpDef":{"type":"integer","format":"int32"},"fl10000YrRpDef":{"type":"integer","format":"int32"},"fl30YrRpUndef":{"type":"integer","format":"int32"},"fl50YrRpUndef":{"type":"integer","format":"int32"},"fl75YrRpUndef":{"type":"integer","format":"int32"},"fl100YrRpUndef":{"type":"integer","format":"int32"},"fl200YrRpUndef":{"type":"integer","format":"int32"},"fl250YrRpUndef":{"type":"integer","format":"int32"},"fl500YrRpUndef":{"type":"integer","format":"int32"},"fl1000YrRpUndef":{"type":"integer","format":"int32"},"fl10000YrRpUndef":{"type":"integer","format":"int32"},"hdFlMatch":{"$ref":"#/components/schemas/ExposureValue"},"flFfHag":{"type":"number","format":"double"},"flFfHagFlag":{"$ref":"#/components/schemas/ExposureValue"},"flZoneGroup":{"type":"integer","format":"int32"},"flPerBasement":{"type":"number","format":"double"},"protectedByLevee":{"type":"string"},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"fl10YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl30YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl50YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl100YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl200YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl250YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl500YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl1000YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"uri":{"type":"string","readOnly":true}}},"LocationFrDetail":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationFrDetailId":{"type":"integer","format":"int32","readOnly":true},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"fireDepartmentRatingModifier":{"$ref":"#/components/schemas/ExposureValue"},"fireDepartmentRating":{"$ref":"#/components/schemas/ExposureValue"},"sprinklerSystem":{"$ref":"#/components/schemas/ExposureValue"},"remoteAlarm":{"$ref":"#/components/schemas/ExposureValue"},"frPackage":{"$ref":"#/components/schemas/ExposureValue"},"frProtect":{"$ref":"#/components/schemas/ExposureValue"},"frSalvage":{"$ref":"#/components/schemas/ExposureValue"},"frSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"frRoofCovering":{"$ref":"#/components/schemas/ExposureValue"},"frRoofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"frRoofAge":{"$ref":"#/components/schemas/ExposureValue"},"frRoofVent":{"$ref":"#/components/schemas/ExposureValue"},"frEmberAccumulator":{"$ref":"#/components/schemas/ExposureValue"},"frSuppression":{"$ref":"#/components/schemas/ExposureValue"},"frPerformance":{"$ref":"#/components/schemas/ExposureValue"},"frSetback":{"$ref":"#/components/schemas/ExposureValue"},"frExterior":{"$ref":"#/components/schemas/ExposureValue"},"frResAppurtenant":{"$ref":"#/components/schemas/ExposureValue"},"frComAppurtenant":{"$ref":"#/components/schemas/ExposureValue"},"frDeckType":{"$ref":"#/components/schemas/ExposureValue"},"frHeatResistance":{"$ref":"#/components/schemas/ExposureValue"},"frAccessibilityCondition":{"$ref":"#/components/schemas/ExposureValue"},"wildFireHazard":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSusceptibility":{"$ref":"#/components/schemas/ExposureValue"},"wildFireThreat":{"$ref":"#/components/schemas/ExposureValue"},"wildFireAreaDescription":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSurfaceFuelType":{"$ref":"#/components/schemas/ExposureValue"},"wildFireCommunityPreparedness":{"$ref":"#/components/schemas/ExposureValue"},"wildFireCommunityMatchFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmStructureCondition":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmMachineryEquipmentLocation":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmSiteHazard":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSpecialConditions":{"type":"string"},"wildFireLocalHistory":{"type":"number","format":"double"},"wildFireNearbyHistory":{"type":"number","format":"double"},"wildFireAccessibility":{"$ref":"#/components/schemas/ExposureValue"},"wildFireMatch":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSlope":{"type":"integer","format":"int32"},"wildFireSlopeFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireFuel":{"$ref":"#/components/schemas/ExposureValue"},"wildFireFuelFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireDistanceToVeg":{"type":"integer","format":"int32"},"wildFireDistanceToVegFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireDistanceToVegUnit":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSiteHazVer":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"distanceToWuiIntermix":{"type":"integer","format":"int32","readOnly":true},"distanceToWuiInterface":{"type":"integer","format":"int32","readOnly":true},"stochasticBurnProb":{"type":"number","format":"double","readOnly":true},"urbanConFlagRationScore":{"type":"integer","format":"int32","readOnly":true},"distanceToCalFireVeryHigh":{"type":"number","format":"double","readOnly":true},"distanceToCalFireHigh":{"type":"number","format":"double","readOnly":true},"distanceToCalFireMedium":{"type":"number","format":"double","readOnly":true},"yearLastHistFire250m":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount250m":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount2km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount5km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount10km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount20km":{"type":"integer","format":"int32","readOnly":true},"fireStationName1":{"type":"string","readOnly":true},"fireStationLatitude1":{"type":"number","format":"double","readOnly":true},"fireStationLongitude1":{"type":"number","format":"double","readOnly":true},"fireStationDistance1":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress1":{"type":"string","readOnly":true},"fireStationCityName1":{"type":"string","readOnly":true},"fireStationPostalCode1":{"type":"string","readOnly":true},"fireStationAdmin2name1":{"type":"string","readOnly":true},"fireStationAdmin1code1":{"type":"string","readOnly":true},"fireStationLevel1":{"type":"string","readOnly":true},"fireStationEms1":{"type":"string","readOnly":true},"fireStationType1":{"type":"string","readOnly":true},"fireStationName2":{"type":"string","readOnly":true},"fireStationLatitude2":{"type":"number","format":"double","readOnly":true},"fireStationLongitude2":{"type":"number","format":"double","readOnly":true},"fireStationDistance2":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress2":{"type":"string","readOnly":true},"fireStationCityName2":{"type":"string","readOnly":true},"fireStationPostalCode2":{"type":"string","readOnly":true},"fireStationAdmin2name2":{"type":"string","readOnly":true},"fireStationAdmin1code2":{"type":"string","readOnly":true},"fireStationLevel2":{"type":"string","readOnly":true},"fireStationEms2":{"type":"string","readOnly":true},"fireStationType2":{"type":"string","readOnly":true},"fireStationName3":{"type":"string","readOnly":true},"fireStationLatitude3":{"type":"number","format":"double","readOnly":true},"fireStationLongitude3":{"type":"number","format":"double","readOnly":true},"fireStationDistance3":{"type":"number","format":"double","readOnly":true},"fireStationStreetaddress3":{"type":"string","readOnly":true},"fireStationCityname3":{"type":"string","readOnly":true},"fireStationPostalcode3":{"type":"string","readOnly":true},"fireStationAdmin2name3":{"type":"string","readOnly":true},"fireStationAdmin1code3":{"type":"string","readOnly":true},"fireStationLevel3":{"type":"string","readOnly":true},"fireStationEms3":{"type":"string","readOnly":true},"fireStationType3":{"type":"string","readOnly":true},"fireStationName4":{"type":"string","readOnly":true},"fireStationLatitude4":{"type":"number","format":"double","readOnly":true},"fireStationLongitude4":{"type":"number","format":"double","readOnly":true},"fireStationDistance4":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress4":{"type":"string","readOnly":true},"fireStationCityName4":{"type":"string","readOnly":true},"fireStationPostalCode4":{"type":"string","readOnly":true},"fireStationAdmin2name4":{"type":"string","readOnly":true},"fireStationAdmin1code4":{"type":"string","readOnly":true},"fireStationLevel4":{"type":"string","readOnly":true},"fireStationEms4":{"type":"string","readOnly":true},"fireStationType4":{"type":"string","readOnly":true},"fireStationName5":{"type":"string","readOnly":true},"fireStationLatitude5":{"type":"number","format":"double","readOnly":true},"fireStationLongitude5":{"type":"number","format":"double","readOnly":true},"fireStationDistance5":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress5":{"type":"string","readOnly":true},"fireStationCityName5":{"type":"string","readOnly":true},"fireStationPostalcode5":{"type":"string","readOnly":true},"fireStationAdmin2name5":{"type":"string","readOnly":true},"fireStationAdmin1code5":{"type":"string","readOnly":true},"fireStationLevel5":{"type":"string","readOnly":true},"fireStationEms5":{"type":"string","readOnly":true},"fireStationType5":{"type":"string","readOnly":true},"uri":{"type":"string","readOnly":true}}},"FacReinsurer":{"type":"object","properties":{"id":{"type":"string","description":"ID of facultative reinsurer."},"name":{"type":"string","description":"Name of facultative reinsurer."}}},"ReinsuranceCession":{"required":["type"],"type":"object","properties":{"reinsuranceCessionId":{"description":"ID of reinsurance cession.","type":"integer","format":"int32","readOnly":true},"reinsuranceCessionName":{"description":"Name of reinsurance cession.","type":"string"},"exposureResourceId":{"description":"ID of location or policy exposure. Reinsurance cession applies to this exposure.","type":"integer","format":"int32","example":26113,"readOnly":true},"exposureResourceType":{"description":"Type of reinsurance cession, i.e. location cession (`LOC`) or policy cession (`POL`).","type":"string","readOnly":true,"enum":["LOC","POL"]},"type":{"type":"string","description":"Type of reinsurance cession. One of `Facultative`, `None`, or  `Treaty`.\n\n- If `Facultative`, `facReinsurer` is required.\n- If `Treaty`, `treaty` is required.","enum":["None","Facultative","Treaty"]},"facReinsurer":{"description":"Identifies the facultative reinsurer, the entity to which the cession is made. Required if `type` is `Facultative`. ","$ref":"#/components/schemas/FacReinsurer"},"layerNumber":{"type":"integer","format":"int32","description":"Number to identify reinsurance cession layer, e.g. _1_.  Does not determine the order that reinsurance cessions are applied."},"layerAmount":{"minimum":0,"type":"number","format":"double","description":"Total value of internal layer to which the percentage ceded is applied. \n\nFor example, if the policy is a $10M policy on which 25% of $3M excess of $7M is ceded to a <<glossary:facultative reinsurer>>, the Internal Layer Amounts would be $7M for the first layer and $3M for the second layer. Format for coding is 7000000 for the first layer, 3000000 for the second layer, etc. "},"excessAmount":{"minimum":0,"type":"number","format":"double","description":"Loss level at which the reinsurance layer is liable.\n\nFor example, if the policy is a $10M policy on which 25% of $3M excess of $7M is ceded to a facultative reinsurer, the Internal Layer Attachment Points would be $0 for the first layer and $7M for the second layer. These amounts should be coded as 0 and 7000000."},"percentReinsurance":{"minimum":0,"type":"number","format":"double","description":"Percentage of the reinsurance layer being ceded to the facultative reinsurer (`facReinsurer`) or surplus share treaty (`treaty`).\n\nValue should be specified as a percentage. For example, 25% should be coded as 25, not as 0.25; if the policy is a $10M policy on which 25% of $3M excess of $7M is ceded to a facultative reinsurer, the Percent Ceded to Reinsurer would be 0 for the first layer and 25 for the second layer. No record is necessary for the first layer because 0% is ceded to your company. Will default to 100% if you do not supply a value."},"maolAmount":{"description":"Maximum Any One Life Amount. Not used. Retained for legacy purposes.","type":"number","format":"double"},"priority":{"type":"integer","format":"int32","description":"Inuring priority of reinsurance, i.e. the order in the cession or treaty takes loss. Priority _1_ treaties take loss first. Subsequent numbers take subsequent losses.\n\nA cession or treaty with an inuring priority of “1” inures to the benefit of a cession or treaty with an inuring priority greater than “1.” The default value for all cessions or treaties is “1.” Inuring priorities do not have to be consecutive. The policy or location reinsurance that takes loss first could be “1” and the policy or location reinsurance that takes loss next could be “50” instead of “2;” lesser priority numbers take loss before greater priority numbers."},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's Insurance Solutions."},"uri":{"type":"string","description":"URI of reinsurance cession.","readOnly":true},"treaty":{"description":"ID of <<glossary:surplus share treaty>>. Required if `type` of the reinsurance cession is `Treaty`. ","$ref":"#/components/schemas/TreatyInfo"}}},"TreatyInfo":{"type":"object","properties":{"treatyId":{"description":"ID of treaty.","type":"integer","format":"int32"}},"writeOnly":true},"LocationToDetail":{"required":["yearUpgrade"],"type":"object","properties":{"locationToDetailId":{"type":"integer","format":"int32","readOnly":true},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"percentComplete":{"type":"number","format":"double"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"architecture":{"$ref":"#/components/schemas/ExposureValue"},"cladRate":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"designCode":{"$ref":"#/components/schemas/ExposureValue"},"doorOpenings":{"$ref":"#/components/schemas/ExposureValue"},"externalOrnament":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"maintenance":{"$ref":"#/components/schemas/ExposureValue"},"mechElecSide":{"$ref":"#/components/schemas/ExposureValue"},"otherOpenings":{"$ref":"#/components/schemas/ExposureValue"},"roofAge":{"$ref":"#/components/schemas/ExposureValue"},"roofAnchor":{"$ref":"#/components/schemas/ExposureValue"},"roofEquipment":{"$ref":"#/components/schemas/ExposureValue"},"roofFrame":{"$ref":"#/components/schemas/ExposureValue"},"roofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"roofParpet":{"$ref":"#/components/schemas/ExposureValue"},"roofSystem":{"$ref":"#/components/schemas/ExposureValue"},"windMissile":{"$ref":"#/components/schemas/ExposureValue"},"windVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"floodMissiles":{"$ref":"#/components/schemas/ExposureValue"},"floodProtection":{"$ref":"#/components/schemas/ExposureValue"},"iceDamProtection":{"$ref":"#/components/schemas/ExposureValue"},"plumbingInsulation":{"$ref":"#/components/schemas/ExposureValue"},"atticInsulation":{"$ref":"#/components/schemas/ExposureValue"},"roofVentilation":{"$ref":"#/components/schemas/ExposureValue"},"snowGuards":{"$ref":"#/components/schemas/ExposureValue"},"treeDensity":{"$ref":"#/components/schemas/ExposureValue"},"garaging":{"$ref":"#/components/schemas/ExposureValue"},"toPackage":{"$ref":"#/components/schemas/ExposureValue"},"toProtect":{"$ref":"#/components/schemas/ExposureValue"},"toSalvage":{"$ref":"#/components/schemas/ExposureValue"},"toSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"toRoofAcvFlag":{"type":"boolean"},"toDmgProvision":{"$ref":"#/components/schemas/ExposureValue"},"toFlashing":{"$ref":"#/components/schemas/ExposureValue"},"toIfmStructCondition":{"$ref":"#/components/schemas/ExposureValue"},"toIfmEquipLoc":{"$ref":"#/components/schemas/ExposureValue"},"toIfmSiteHazard":{"$ref":"#/components/schemas/ExposureValue"},"toRemDesign":{"$ref":"#/components/schemas/ExposureValue"},"toRemSpec":{"$ref":"#/components/schemas/ExposureValue"},"toRemMitigation":{"$ref":"#/components/schemas/ExposureValue"},"toRemSite":{"$ref":"#/components/schemas/ExposureValue"},"toDepreciationAge":{"$ref":"#/components/schemas/ExposureValue"},"dominantSubperilCS":{"type":"integer","format":"int64","readOnly":true},"percentInGeographyCS":{"type":"number","format":"double","readOnly":true},"score1CS":{"type":"integer","format":"int32","readOnly":true},"score2CS":{"type":"integer","format":"int32","readOnly":true},"score3CS":{"type":"integer","format":"int32","readOnly":true},"scoreOverallCS":{"type":"integer","format":"int32","readOnly":true},"dominantSubperilWT":{"type":"integer","format":"int64","readOnly":true},"percentInGeographyWT":{"type":"number","format":"double","readOnly":true},"score1WT":{"type":"integer","format":"int32","readOnly":true},"score2WT":{"type":"integer","format":"int32","readOnly":true},"score3WT":{"type":"integer","format":"int32","readOnly":true},"scoreOverallWT":{"type":"integer","format":"int32","readOnly":true},"uri":{"type":"string","readOnly":true}}},"LocationTrDetail":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationTrDetailId":{"type":"integer","format":"int32","readOnly":true},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"trPackage":{"$ref":"#/components/schemas/ExposureValue"},"trProtect":{"$ref":"#/components/schemas/ExposureValue"},"trSalvage":{"$ref":"#/components/schemas/ExposureValue"},"trSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"score1":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"targetsName1":{"type":"string","readOnly":true},"targetsId1":{"type":"integer","format":"int32","readOnly":true},"targetsScore1":{"type":"number","format":"double","readOnly":true},"targetsDistance1":{"type":"number","format":"double","readOnly":true},"targetsCategory1":{"type":"number","format":"double","readOnly":true},"targetsCityName1":{"type":"string","readOnly":true},"targetsAdmin1code1":{"type":"string","readOnly":true},"targetsName2":{"type":"string","readOnly":true},"targetsId2":{"type":"integer","format":"int32","readOnly":true},"targetsScore2":{"type":"number","format":"double","readOnly":true},"targetsDistance2":{"type":"number","format":"double","readOnly":true},"targetsCategory2":{"type":"number","format":"double","readOnly":true},"targetsCityName2":{"type":"string","readOnly":true},"targetsAdmin1code2":{"type":"string","readOnly":true},"targetsName3":{"type":"string","readOnly":true},"targetsId3":{"type":"integer","format":"int32","readOnly":true},"targetsScore3":{"type":"number","format":"double","readOnly":true},"targetsDistance3":{"type":"number","format":"double","readOnly":true},"targetsCategory3":{"type":"number","format":"double","readOnly":true},"targetsCityName3":{"type":"string","readOnly":true},"targetsAdmin1code3":{"type":"string","readOnly":true},"targetsName4":{"type":"string","readOnly":true},"targetsId4":{"type":"integer","format":"int32","readOnly":true},"targetsScore4":{"type":"number","format":"double","readOnly":true},"targetsDistance4":{"type":"number","format":"double","readOnly":true},"targetsCategory4":{"type":"number","format":"double","readOnly":true},"targetsCityName4":{"type":"string","readOnly":true},"targetsAdmin1code4":{"type":"string","readOnly":true},"targetsName5":{"type":"string","readOnly":true},"targetsId5":{"type":"integer","format":"int32","readOnly":true},"targetsScore5":{"type":"number","format":"double","readOnly":true},"targetsDistance5":{"type":"number","format":"double","readOnly":true},"targetsCategory5":{"type":"number","format":"double","readOnly":true},"targetsCityName5":{"type":"string","readOnly":true},"targetsAdmin1code5":{"type":"string","readOnly":true},"uri":{"type":"string","readOnly":true}}},"LocationWcDetail":{"type":"object","properties":{"locationWcDetailId":{"type":"integer","format":"int32","readOnly":true},"totalPayroll":{"type":"number","format":"double"},"totalNumEmployees":{"type":"number","format":"double"},"numEmployeesShift1":{"type":"number","format":"double"},"numEmployeesShift2":{"type":"number","format":"double"},"numEmployeesShift3":{"type":"number","format":"double"},"numEmployeesShift4":{"type":"number","format":"double"},"calcNumEmployees":{"type":"number","format":"double"},"emergencyProtection":{"$ref":"#/components/schemas/ExposureValue"},"hazardousMaterials":{"$ref":"#/components/schemas/ExposureValue"},"wageRelativity":{"$ref":"#/components/schemas/ExposureValue"},"riskManagement":{"$ref":"#/components/schemas/ExposureValue"},"employeeDensity":{"$ref":"#/components/schemas/ExposureValue"},"uslh":{"type":"boolean"},"excessComp":{"$ref":"#/components/schemas/ExposureValue"},"undMngtAdjustment":{"type":"number","format":"double"},"groupNum":{"type":"string"},"groupName":{"type":"string"},"occupancyTypeScheme":{"$ref":"#/components/schemas/ExposureValue"},"occupancyType":{"$ref":"#/components/schemas/ExposureValue"},"maxEmployees":{"type":"number","format":"double"},"shiftType":{"$ref":"#/components/schemas/ExposureValue"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true}}},"LocationWsDetail":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationWsDetailId":{"type":"integer","format":"int32","readOnly":true},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"coastalSegment":{"type":"string"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"sicOccupancy":{"type":"string"},"ibcOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"architecture":{"$ref":"#/components/schemas/ExposureValue"},"cladRate":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"designCode":{"$ref":"#/components/schemas/ExposureValue"},"doorOpenings":{"$ref":"#/components/schemas/ExposureValue"},"externalOrnament":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"maintenance":{"$ref":"#/components/schemas/ExposureValue"},"mechElecSide":{"$ref":"#/components/schemas/ExposureValue"},"otherOpenings":{"$ref":"#/components/schemas/ExposureValue"},"roofAge":{"$ref":"#/components/schemas/ExposureValue"},"roofAnchor":{"$ref":"#/components/schemas/ExposureValue"},"roofEquipment":{"$ref":"#/components/schemas/ExposureValue"},"roofFrame":{"$ref":"#/components/schemas/ExposureValue"},"roofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"roofParpet":{"$ref":"#/components/schemas/ExposureValue"},"roofSystem":{"$ref":"#/components/schemas/ExposureValue"},"windMissile":{"$ref":"#/components/schemas/ExposureValue"},"windVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"floodMissiles":{"$ref":"#/components/schemas/ExposureValue"},"floodProtection":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"flashing":{"$ref":"#/components/schemas/ExposureValue"},"ifmVerticalExpDist":{"$ref":"#/components/schemas/ExposureValue"},"ifmStructCondition":{"$ref":"#/components/schemas/ExposureValue"},"ifmEquipBracing":{"$ref":"#/components/schemas/ExposureValue"},"ifmMissileExp":{"$ref":"#/components/schemas/ExposureValue"},"wsPackage":{"$ref":"#/components/schemas/ExposureValue"},"wsProtect":{"$ref":"#/components/schemas/ExposureValue"},"wsSalvage":{"$ref":"#/components/schemas/ExposureValue"},"wsSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"resistGarage":{"$ref":"#/components/schemas/ExposureValue"},"wsFloorType":{"$ref":"#/components/schemas/ExposureValue"},"wsFoundationType":{"$ref":"#/components/schemas/ExposureValue"},"contamination":{"$ref":"#/components/schemas/ExposureValue"},"floodDuration":{"$ref":"#/components/schemas/ExposureValue"},"garaging":{"$ref":"#/components/schemas/ExposureValue"},"treeDensity":{"$ref":"#/components/schemas/ExposureValue"},"depreciationAge":{"$ref":"#/components/schemas/ExposureValue"},"velocity":{"$ref":"#/components/schemas/ExposureValue"},"floodIndex":{"type":"number","format":"double"},"distToCoast":{"type":"number","format":"double"},"sysDistToCoast":{"type":"number","format":"double"},"elevation":{"type":"number","format":"double"},"manMadeCov":{"type":"number","format":"double"},"naturalCov":{"type":"number","format":"double"},"elevationCov":{"type":"number","format":"double"},"distToCoastCov":{"type":"number","format":"double"},"manMadeRoughness":{"type":"integer","format":"int32"},"naturalRoughness":{"type":"integer","format":"int32"},"windPool":{"type":"integer","format":"int32"},"biZone":{"type":"integer","format":"int32"},"topologyFeature":{"type":"integer","format":"int32"},"elevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"naturalRoughnessMatch":{"$ref":"#/components/schemas/ExposureValue"},"manMadeRoughnessMatch":{"$ref":"#/components/schemas/ExposureValue"},"distToCoastMatch":{"$ref":"#/components/schemas/ExposureValue"},"windPoolMatch":{"$ref":"#/components/schemas/ExposureValue"},"windExposure":{"type":"integer","format":"int32"},"nfipRate":{"type":"number","format":"double"},"nfipYear":{"type":"integer","format":"int32"},"nfipYearMatch":{"$ref":"#/components/schemas/ExposureValue"},"buildingElevation":{"type":"number","format":"double"},"buildingElevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"rmsBuildingElevation":{"type":"number","format":"double"},"rmsBuildingElevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"zoneGroup":{"type":"integer","format":"int32"},"perBasement":{"type":"number","format":"double"},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"windpoolZone":{"type":"string","readOnly":true},"distanceToInnerCoast":{"type":"number","format":"double","readOnly":true},"ws1YrRpWind":{"type":"number","format":"double","readOnly":true},"ws2YrRpWind":{"type":"number","format":"double","readOnly":true},"ws5YrRpWind":{"type":"number","format":"double","readOnly":true},"ws10YrRpWind":{"type":"number","format":"double","readOnly":true},"ws25YrRpWind":{"type":"number","format":"double","readOnly":true},"ws50YrRpWind":{"type":"number","format":"double","readOnly":true},"ws100YrRpWind":{"type":"number","format":"double","readOnly":true},"ws200YrRpWind":{"type":"number","format":"double","readOnly":true},"ws250YrRpWind":{"type":"number","format":"double","readOnly":true},"ws500YrRpWind":{"type":"number","format":"double","readOnly":true},"ws1000YrRpWind":{"type":"number","format":"double","readOnly":true},"ws10000YrRpWind":{"type":"number","format":"double","readOnly":true},"ws1YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws2YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws5YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws10YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws25YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws50YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws100YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws200YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws250YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws500YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws1000YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws10000YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"uri":{"type":"string","readOnly":true}}},"EnrichedDetails":{"required":["locId"],"type":"object","properties":{"locId":{"type":"integer","format":"int32"},"airConditioningDescription":{"type":"string"},"buildingHeight":{"type":"integer","format":"int32"},"buildingValuationLowerRange":{"type":"number","format":"double"},"buildingValuationUpperRange":{"type":"number","format":"double"},"construction":{"type":"string"},"constructionSource":{"type":"string"},"currencyCode":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"esdbVersion":{"type":"string"},"exteriorDescription":{"type":"string"},"floorArea":{"type":"integer","format":"int64"},"floorAreaSource":{"type":"string"},"floorOccupancy":{"type":"string"},"floorOccupancyDescription":{"type":"string"},"foundationSystemDescription":{"type":"string"},"garagingDescription":{"type":"string"},"heatingTypeDescription":{"type":"string"},"isHD":{"type":"integer","format":"int32"},"isPrimaryBuildingFlag":{"type":"integer","format":"int32"},"multipleBuildingFlag":{"type":"integer","format":"int32"},"numberOfBaths":{"type":"integer","format":"int32"},"numberOfBedrooms":{"type":"integer","format":"int32"},"numberOfUnits":{"type":"integer","format":"int32"},"numOfStories":{"type":"integer","format":"int32"},"numOfStoriesSource":{"type":"string"},"occupancy":{"type":"string"},"occupancy2":{"type":"string"},"occupancy3":{"type":"string"},"occupancySource":{"type":"string"},"pool":{"type":"string"},"roofCoverCode":{"type":"string"},"roofCoverDescription":{"type":"string"},"roofGeometryCode":{"type":"string"},"roofGeometryDescription":{"type":"string"},"versionId":{"type":"number","format":"double"},"yearBuilt":{"type":"integer","format":"int32"},"yearBuiltSource":{"type":"string"}}},"LocationDetails":{"required":["address","property"],"type":"object","properties":{"property":{"$ref":"#/components/schemas/Property"},"address":{"$ref":"#/components/schemas/Address"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"tiv":{"type":"number","format":"double","description":"Replacment cost (total insurable value) of <<glossary:location coverage>> values for buildings, building contents, and business interruptions at location."},"riskAssessorCurves":{"type":"string"},"maxCvgBldgValuation":{"type":"number","format":"double"},"uri":{"type":"string","readOnly":true},"locationBiDetail":{"$ref":"#/components/schemas/LocationBiDetail"},"locationEqDetail":{"$ref":"#/components/schemas/LocationEqDetail"},"locationWsDetail":{"$ref":"#/components/schemas/LocationWsDetail"},"locationToDetail":{"$ref":"#/components/schemas/LocationToDetail"},"locationFlDetail":{"$ref":"#/components/schemas/LocationFlDetail"},"locationFrDetail":{"$ref":"#/components/schemas/LocationFrDetail"},"locationTrDetail":{"$ref":"#/components/schemas/LocationTrDetail"},"buildingAttribute":{"$ref":"#/components/schemas/BuildingAttribute"},"locationCoverages":{"type":"array","items":{"$ref":"#/components/schemas/LocationCoverage"}},"reinsuranceCessions":{"type":"array","items":{"$ref":"#/components/schemas/ReinsuranceCessionDetails"}},"locationWcDetails":{"type":"array","items":{"$ref":"#/components/schemas/LocationWcDetail"}},"locationConditions":{"type":"array","items":{"$ref":"#/components/schemas/LocationCondition"}}}},"ReinsuranceCessionDetails":{"required":["type"],"type":"object","properties":{"reinsuranceCessionId":{"type":"integer","format":"int32","description":"ID of reinsurance cession.","readOnly":true},"reinsuranceCessionName":{"type":"string","description":"Name of reinsurance cession."},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113,"readOnly":true},"exposureResourceType":{"type":"string","readOnly":true,"enum":["POL","LOC"]},"type":{"type":"string","description":"Type of reinsurance cession.","enum":["None","Facultative","Treaty"]},"facReinsurer":{"description":"Identifies the facultative reinsurer, the entity to which the cession is made. Required if `type` is `Facultative`.","$ref":"#/components/schemas/FacReinsurer"},"layerNumber":{"type":"integer","format":"int32","description":"Number of reinsurance layer."},"layerAmount":{"minimum":0,"type":"number","format":"double","description":"Total value of insurance for the entire reinsurance layer. "},"excessAmount":{"minimum":0,"type":"number","format":"double","description":"Loss level at which the reinsurance layer is liable."},"percentReinsurance":{"minimum":0,"type":"number","format":"double","description":"Reinsurer's participating percentage of the entire reinsurance layer."},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double"},"priority":{"description":"Inuring priority of reinsurance. Priority _1_ treaties take loss first. Subsequent numbers take subsequent losses.","type":"integer","format":"int32"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true,"description":"URI of reinsurance cession."},"treaty":{"description":"Identifies treaty cession. Required if `type` is `Treaty`.","$ref":"#/components/schemas/Treaty"}}},"LocationPolicyCondition":{"type":"object","properties":{"policyConditionId":{"description":"ID of policy condition.","type":"integer","format":"int32","example":44},"policyConditionName":{"type":"string","description":"Name of policy condition.","example":"TC_update_negative"},"isPredefined":{"type":"boolean","description":"If `true`, policy condition is predefined. If `false`, policy condition is ad-hoc.","example":false},"limit":{"description":"Total coverage amount provided by the condition. Is multiplied by insurer's pro-rata participation to determine their exposure.","type":"number","format":"double"},"deductible":{"description":"Deductible associated with the condition. Values <= 1 are interpreted as percentages; values > 1 are interpreted as flat amounts. By default, `0`.","type":"number","format":"double"},"deductibleType":{"description":"Type of deductible. ","type":"string","example":"DEFAULT","enum":["DEFAULT"]},"conditionType":{"description":"Type of condition. If `POLICY_RESTRICTION`, condition restricts all policy coverage to specific locations. If `SUBLIMIT`, condition limits coverage to a subset of locations.","type":"string","example":"POLICY_RESTRICTION","enum":["POLICY_RESTRICTION","SUBLIMIT"]},"parentCondition":{"description":"ID of parent condition when the policy condition is a sub-condition.","example":"UAW_sublimit","$ref":"#/components/schemas/ExposureValue"},"policyNumber":{"description":"ID of policy. If policy condition is predefined, `0`.","type":"string","example":56},"percentOfLossDeductibleAmount":{"description":"Deductible expressed as a percentage of loss for coverage or combination of coverages. As the loss increases, the deductible amount increases. HD models only.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","example":"NO","enum":["YES","NO"]},"uri":{"type":"string","example":"/platform/riskdata/v1/exposures/6/locations/132/locationconditions/44"}}},"LocationSearchItem":{"type":"object","properties":{"propertyReference":{"type":"string"},"location":{"$ref":"#/components/schemas/Location"}}},"Link":{"required":["href","method","rel"],"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"method":{"type":"string"}}},"Meta":{"type":"object","properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"count":{"type":"integer","format":"int32"}}},"MetaLinks":{"required":["links","meta"],"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"PolicyCondition":{"required":["policyConditionName"],"type":"object","properties":{"policyConditionId":{"description":"ID of policy condition.","type":"integer","format":"int32","readOnly":true,"example":44},"policyConditionName":{"description":"Name of policy condition.","maxLength":40,"minLength":1,"type":"string","example":"TC_update-negative"},"isPredefined":{"description":"If `true`, policy condition is predefined. If `false`, policy condition is ad-hoc.","type":"boolean","example":false},"limit":{"description":"Total coverage amount provided by the condition. Is multiplied by insurer's pro-rata participation to determine their exposure.","type":"number","format":"double","example":1200000},"deductible":{"description":"Deductible associated with the condition. Values <= 1 are interpreted as percentages; values > 1 are interpreted as flat amounts. By default, `0`.","type":"number","format":"double","example":2000000},"deductibleType":{"description":"Type of deductible. ","type":"string","example":"DEFAULT","enum":["DEFAULT"]},"conditionType":{"description":"Type of condition. If `POLICY_RESTRICTION`, condition restricts all policy coverage to specific locations. If `SUBLIMIT`, condition limits coverage to a subset of locations.","type":"string","example":"POLICY_RESTRICTION","enum":["POLICY_RESTRICTION","SUBLIMIT"]},"parentCondition":{"description":"ID of parent condition when the policy condition is a sub-condition.","$ref":"#/components/schemas/ExposureValue"},"policyNumber":{"description":"ID of policy.","type":"string","readOnly":true,"example":56},"policyConditionCriterias":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PolicyConditionCriteria"}},"percentOfLossDeductibleAmount":{"description":"Deductible expressed as a percentage of loss for coverage or combination of coverages. As the loss increases, the deductible amount increases. HD models only.","type":"number","format":"double","example":0},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","example":"NO","enum":["YES","NO"]},"uri":{"type":"string","readOnly":true,"example":"/platform/riskdata/v1/exposures/6/policyconditions/44"}}},"PolicyConditionCriteria":{"description":"Objects that define query statements for selecting locations. Policy conditions may apply to matching locations. ","type":"object","properties":{"id":{"type":"integer","format":"int32","example":1},"logic":{"description":"Logical operator connecting two statements in a compound query.","type":"string","example":"AND"},"openPar":{"description":"Opening parenthesis in compound query. One of `(`, `((`, `(((`","type":"string","example":"("},"field":{"description":"Location property used as filter.","type":"string","example":"POSTALCODE"},"operator":{"description":"Comparision operator in query. One of `=`, `>`, `<`, `>=`, `<=`","type":"string","example":"="},"value":{"description":"Value of `field` property.","type":"string","example":94514},"closePar":{"description":"Closing parenthesis in compound query. One of `)`, `))`, `)))`","type":"string","example":")"}}},"Policy":{"required":["policyNumber","status"],"type":"object","properties":{"policyId":{"description":"ID of policy.","type":"integer","format":"int32","readOnly":true},"policyNumber":{"type":"string","description":"Number of policy."},"accountId":{"type":"integer","format":"int32","description":"ID of account. Policy terms cover locations attached to the account. "},"lob":{"description":"Classification of business, e.g. auto, commercial, personal, or residence. Required for some types of reinsurance.\n\nDetermines level of output if the granularity specified in <<glossary:output profile>> is based on the LOB (e.g. Cresta by LOB). ","$ref":"#/components/schemas/LineOfBusinessInfo"},"peril":{"type":"string","description":"Peril covered by policy.","enum":["EARTHQUAKE","FIRE","FLOOD","TERRORISM","TORNADO","WINDSTORM","WORKERSCOMP"]},"status":{"type":"string","description":"Processing status of policy.","enum":["Booked","Cancelled","Expired","Multiple","Pending","Quote","Unknown","What_if"]},"inceptionDate":{"description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"partOf":{"type":"number","description":"Percentage or currency amount of policy layer. If `blanketLimit` is a percentage value, must be currency amount.  ","format":"double"},"attachmentPoint":{"type":"number","description":"Amount at which the policy begins to take losses. ","format":"double"},"minDeductible":{"description":"Minimum amount taken by policy regardless of location coverage or site deductibles.","type":"number","format":"double"},"maxDeductible":{"description":"Maximum amount taken by policy regardless of location coverage or site deductibles. ","type":"number","format":"double"},"blanketLimit":{"description":"Maximum amount covered by insurer for the specified peril, as a percentage or currency amount. ","type":"number","format":"double"},"blanketDeductible":{"description":"Amount or percent of total exposure. \n\n- If policy has single deductible, applied to all locations and all coverages. \n- If policy has multiple locations, based on all location values, not just locations damaged.","type":"number","format":"double"},"blanketPremium":{"description":"Amount insurer or reinsurer charges to provide coverage described in policy.","type":"number","format":"double"},"biLifeLine":{"description":"Not used. Retained for legacy purposes.","type":"integer","format":"int32"},"deductType":{"description":"Not used. Retained for legacy purposes.","type":"integer","format":"int32"},"structure":{"type":"string","description":"Structure of policy. \n\n* If `Standard`, policy is standard policy. \n* If `Step`, policy is step policy (DLM model).","enum":["Standard","Step"]},"coverageBase":{"description":"Coverage by layer of step policy, e.g., for some layers, the trigger point may be calculated based on the building damage only.","type":"string","enum":["BUILDING","CONTENTS_OR_BI","BUILDING_OR_CONTENTS_OR_BI","CONTENTS","BI","BUILDING_AND_CONTENTS","BUILDING_AND_BI","CONTENTS_AND_BI","BUILDING_AND_CONTENTS_AND_BI","BUILDING_OR_CONTENTS","BUILDING_OR_BI","NOT_APPLICABLE"]},"limitGU":{"type":"string","description":"Payment limits by layer in step policy. Used in modeling of step policies.","enum":["ACTUAL_PAYMENT_GU_LOSS_LIMITED","ACTUAL_PAYMENT_GU_LOSS_NOT_LIMITED","NOT_APPLICABLE"]},"userText1":{"type":"string","description":"User-defined note."},"userText2":{"type":"string","description":"User-defined note."},"userText3":{"type":"string","description":"User-defined note."},"userText4":{"type":"string","description":"User-defined note."},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"newCauseOfLoss":{"type":"string","description":"Collection of perils that enables a policy to cover more than a single peril. Not considered for accumulations. Applicable to HD models only. ","enum":["EARTHQUAKE","FIRE","FLOOD","NONE","SEVERE_CONVECTIVE_STORM","TERRORISM","TERRORISM_CBRN_ONLY","TERRORISM_CONVENTIONAL_ONLY","WATER","WIND","WINDSTORM","WIND_AND_WATER"]},"percentOfLossDeductible":{"description":"Deductible expressed as a percentage of loss for coverage or combination of coverages. As the loss increases, the deductible amount increases. HD models only.","type":"number","format":"double"},"isFranchiseDeductible":{"type":"string","description":"If `YES`, is franchise deductible. If `NO`, deductible is conventional.","enum":["YES","NO"]},"aggregateMinDeductible":{"description":"Amount of minimum aggregate deductible for standard policies. No payout occurs until this deductible is satisfied. Lower level deductibles (e.g., site deductibles) erode this policy-level term. HD models only. ","type":"number","format":"double"},"aggregateMaxDeductible":{"description":"Amount of maximum aggregate deductible for standard policies.","type":"number","format":"double"},"aggregateLimit":{"type":"number","format":"double","description":"Limit of the aggregate deductible layer."},"uri":{"type":"string","readOnly":true}}},"PolicyCoverage":{"required":["label","lossType","peril"],"type":"object","properties":{"policyCoverageId":{"type":"integer","description":"System-defined ID of policy coverage record.","format":"int32","readOnly":true},"peril":{"type":"string","description":"Peril covered by policy coverage.","enum":["EARTHQUAKE","FIRE","FLOOD","TERRORISM","TORNADO","WINDSTORM","WORKERSCOMP"]},"lossType":{"type":"string","description":"Type of losses covered. Multiple loss types are not supported. ","enum":["BI","Building","CombinedCvg","Contents"]},"premium":{"type":"number","format":"double","description":"Premium amount."},"limit":{"type":"number","format":"double","description":"Policy-level limit for total building, contents, or business interruption loss from all locations. Used in conjunction with a blanketLimit, policy-level limits are applied before the blanketLimit."},"deductible":{"type":"number","description":"Deductible applied to `lossType`. A combined deductible applies to the sum of Building and Contents losses from all locations within the policy.","format":"double"},"label":{"description":"Maps `peril` values (e.g. `EQ`, `WS`) to `lossType` values (e.g. BI, Contents). ","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of `peril`-`lossType` mapping. If specified, `code` and `name` can be blank."},"code":{"type":"string","description":"Code for peril. One of `FL` (FLOOD), `FR` (FIRE), `EQ` (EARTHQUAKE), `TO` (TORNADO), `TR` (TERRORISM), `WS` (WINDSTORM). Required if `id` is undefined."},"name":{"type":"string","description":"Name of `lossType`. One of `BI`, `Building`, `Contents`, `CombinedCvg`. Required if `id` is undefined."}}},"accumulation":{"type":"string","description":"ID of accumulation.  One of `Building`, `Content`, `BI`.","enum":["Bi","Building","Contents"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"percentOfLossDeductibleAmount":{"description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases. HD models only.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional. HD models only.","type":"string","enum":["YES","NO"]},"uri":{"type":"string","readOnly":true}}},"PolicyDetail":{"required":["policyNumber","status"],"type":"object","properties":{"policyId":{"type":"integer","description":"ID of policy.","format":"int32","readOnly":true},"policyNumber":{"description":"Number of policy.","type":"string"},"accountId":{"type":"integer","description":"ID of account.","format":"int32"},"lob":{"$ref":"#/components/schemas/LineOfBusinessInfo"},"peril":{"type":"string","enum":["EARTHQUAKE","WINDSTORM","TORNADO","FLOOD","FIRE","TERRORISM","WORKERSCOMP"]},"status":{"type":"string","enum":["Booked","Cancelled","Expired","Multiple","Pending","Quote","Unknown","What_if"]},"inceptionDate":{"description":"Start date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"description":"End date in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"currency":{"description":"Currency.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"partOf":{"type":"number","format":"double"},"attachmentPoint":{"type":"number","description":"Amount at which the occurrence layer begins to take loss.","format":"double"},"minDeductible":{"type":"number","format":"double"},"maxDeductible":{"type":"number","format":"double"},"blanketLimit":{"type":"number","format":"double"},"blanketDeductible":{"type":"number","format":"double"},"blanketPremium":{"type":"number","format":"double"},"biLifeLine":{"type":"integer","description":"Not used. Retained for legacy purposes.","format":"int32"},"deductType":{"type":"integer","description":"Not used. Retained for legacy purposes.","format":"int32"},"structure":{"type":"string","description":"Type of policy.","enum":["Standard","Step"]},"coverageBase":{"type":"string","enum":["BI","BUILDING","BUILDING_AND_BI","BUILDING_AND_CONTENTS","BUILDING_AND_CONTENTS_AND_BI","BUILDING_OR_BI","BUILDING_OR_CONTENTS","BUILDING_OR_CONTENTS_OR_BI","CONTENTS","CONTENTS_AND_BI","CONTENTS_OR_BI","NOT_APPLICABLE"]},"limitGU":{"type":"string","description":"Scope of actual payment. \n\n* If `NOT_APPLICABLE`, actual payment is not affected. Used for standard policies and step policies where `peril` = `WC`\n* If `ACTUAL_PAYMENT_GU_LOSS_LIMITED`, actual payment is limited to GU loss. \n* If `ACTUAL_PAYMENT_GU_NOT_LOSS_LIMITED`, actual payment is not limited to GU loss. ","enum":["ACTUAL_PAYMENT_GU_LOSS_LIMITED","ACTUAL_PAYMENT_GU_LOSS_NOT_LIMITED","NOT_APPLICABLE"]},"userText1":{"type":"string","description":"User-defined note."},"userText2":{"type":"string","description":"User-defined note."},"userText3":{"type":"string","description":"User-defined note."},"userText4":{"type":"string","description":"User-defined note."},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"newCauseOfLoss":{"type":"string","description":"Collection of perils covered by policy. Used by HD models only. ","enum":["EARTHQUAKE","FIRE","FLOOD","NONE","SEVERE_CONVECTIVE_STORM","TERRORISM","TERRORISM_CBRN_ONLY","TERRORISM_CONVENTIONAL_ONLY","WATER","WIND","WINDSTORM","WIND_AND_WATER"]},"percentOfLossDeductible":{"description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","enum":["YES","NO"]},"aggregateMinDeductible":{"type":"number","description":"Value of minimum aggregate deductible for standard policies.","format":"double"},"aggregateMaxDeductible":{"type":"number","description":"Value of maximum aggregate deductible for standard policies.","format":"double"},"aggregateLimit":{"type":"number","description":"Minimum aggregate deductible amount.","format":"double"},"uri":{"type":"string","readOnly":true},"coverages":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PolicyCoverage"}},"reinsuranceCessions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/ReinsuranceCessionDetails"}},"policyConditions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PolicyCondition"}}}},"Portfolio":{"required":["description","portfolioName","portfolioNumber"],"type":"object","properties":{"portfolioId":{"description":"ID of portfolio.","type":"integer","format":"int32","readOnly":true},"portfolioName":{"description":"Name of portfolio.","maxLength":40,"minLength":0,"type":"string"},"portfolioNumber":{"description":"Number of portfolio.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of portfolio.","maxLength":255,"minLength":0,"type":"string"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"stampDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"uri":{"type":"string","readOnly":true},"tagIds":{"description":"List of tags to apply to this portfolio. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"PortfolioMetrics":{"type":"object","properties":{"totalAccounts":{"type":"integer","description":"Total number of accounts.","format":"int32"},"totalLocations":{"type":"integer","description":"Total number of locations.","format":"int32"},"totalPolicies":{"type":"integer","description":"Total number of policies.","format":"int32"},"perilsExposed":{"type":"string"},"name":{"type":"string"},"number":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`\n"},"geocodeVersion":{"type":"string"},"hazardVersion":{"type":"string","description":"List of hazard models run on this portfolio.\n"}}},"PortfolioFilteredAccountsInput":{"type":"object","properties":{"selectAll":{"type":"boolean","description":"Scope of accounts to add to portfolio. If `true`, adds all accounts selected by the specified `queryFilter` parameter. If no `queryFilter` parameter is specified, all accounts are added to the portfolio. Overrides `markedAccounts` parameter. "},"queryFilter":{"type":"string","description":"Expression that selects accounts. All accounts returned by the query are added to the portfolio."},"markedAccounts":{"type":"array","description":"List of accounts identified by account ID. The specified accounts are added to the portfolio.","items":{"type":"integer","format":"int32"}},"manageExistingAccounts":{"type":"boolean","description":"Scope of accounts. If `true`, only existing accounts can be added to portfolio. All specified `markedAccount` values are ignored.  All specified `queryFilter` values are ignored."}}},"PortfolioAccountsInput":{"type":"object","properties":{"accountsToAdd":{"description":"List of accounts to add to portfolio.","type":"array","items":{"type":"integer","format":"int32"}},"accountsToRemove":{"description":"List of accounts to remove from portfolio.","type":"array","items":{"type":"integer","format":"int32"}}}},"PortfolioSearch":{"required":["description","portfolioName","portfolioNumber"],"type":"object","properties":{"portfolioId":{"description":"ID of portfolio.","type":"integer","format":"int32","readOnly":true},"portfolioName":{"description":"Name of portfolio.","maxLength":40,"minLength":0,"type":"string"},"portfolioNumber":{"description":"Number of portfolio.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of portfolio.","maxLength":255,"minLength":0,"type":"string"},"createDate":{"type":"string","readOnly":true,"description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`\n"},"stampDate":{"type":"string","readOnly":true,"description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`\n"},"uri":{"type":"string","readOnly":true},"geocodeVersion":{"type":"string"},"hazardVersion":{"type":"string","description":"List of hazard models run on this portfolio.\n"},"ownerName":{"type":"string","description":"Name of owner."},"updatedBy":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`\n"},"tagIds":{"description":"List of tags to apply to portfolio. See [Tags](ref:reference-data-api-overview).","type":"array","items":{"type":"integer","format":"int32"}}}},"Producer":{"required":["producerName"],"type":"object","properties":{"producerId":{"maxLength":20,"minLength":0,"pattern":"^\\w([\\w-]*\\w|)$","type":"string","example":22},"producerName":{"maxLength":40,"minLength":1,"type":"string","example":"CSW"},"uri":{"type":"string","readOnly":true,"example":"/platform/riskdata/v1/exposures/5/producers/22"}}},"StepPolicy":{"required":["expirationDate","inceptionDate","stepPolicyNumber"],"type":"object","properties":{"stepPolicyId":{"description":"System-generated ID of step policy.","type":"integer","format":"int32","readOnly":true},"accountId":{"description":"ID of account. ","minimum":1,"type":"integer","format":"int32"},"stepPolicyNumber":{"description":"Number of HD step policy. Unique within portfolio.","maxLength":50,"minLength":1,"type":"string"},"stepPolicyName":{"description":"Name of HD step policy.","maxLength":50,"minLength":0,"type":"string"},"stepOrderId":{"description":"ID of step (interval) within a step policy. \n\nUnique within an `accountId`, e.g, Account1 can have steps 1-3, and Account2 can have steps 1-4.","type":"integer","format":"int32"},"lob":{"description":"Type of business covered, e.g. fire, commercial, personal, auto, or residence. _Not applicable to interaction steps._\n\nDetermines level of output if the granularity specified in <<glossary:output profile>> is based on the LOB  (e.g. `Cresta by LOB`). If multiple `lobId`s are specified, the lowest `lobId` is used. ","$ref":"#/components/schemas/LineOfBusinessInfo"},"causeOfLoss":{"type":"string","description":"<<glossary:Subperil>> or combined subperils that trigger loss.\n\nOptions can specify collection of subperils, e.g. if `WATER` is specified either coastal flood and inland flood trigger loss, but wind is excluded as trigger. Not applicable to interaction steps. ","enum":["EARTHQUAKE","FIRE","FLOOD","NONE","SEVERE_CONVECTIVE_STORM","TERRORISM","TERRORISM_CBRN_ONLY","TERRORISM_CONVENTIONAL_ONLY","WATER","WIND","WINDSTORM","WIND_AND_WATER"]},"inceptionDate":{"type":"string","description":"Start date of policy in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`. If multiple dates are specified in the HD step policy, earliest `inceptionDate` is used.  _Not applicable to interaction steps_.\n\nApplicable if Apply Contract Dates option is specified in <<glossary:model profile>>, otherwise first year in <<glossary:period event table>> is used.  "},"expirationDate":{"type":"string","description":"End date of policy in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`. If multiple dates are specified in the HD step policy, latest `expirationDate` is used. _Not applicable to interaction steps_.\n\nWhen the Apply Contract Dates option is selected for HD model profiles, an analysis considers the earliest inception date and the latest expiration date across all the policies in an account.\n\nIf an account has HD step policies only, the analysis considers the earliest inception date (and latest expiration date) across all relevant child steps as the contract inception (and expiration) date, i.e., for cases where `childOrderId` is an empty string. It ignores interaction record dates."},"payoutAmount":{"description":"Maximum amount covered by the insurer for the specified policy peril.\n\n- If less than or equal to _1_, percent of replacement cost value affected. \n- If greater than _1_ , monetary amount.","type":"number","format":"double"},"currency":{"description":"Currency of HD step policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"payoutFunction":{"type":"string","description":"Method used to determine `payoutAmount`.\n\n- If `Standard`, the value of `payoutAmount` represents a constant, flat amount. Typical of simple steps.\n- If `Step`, the value of `payoutAmount` represents a cap on the amount payout. Typical of interaction steps.","enum":["Standard","Step"]},"share":{"description":"Percent share of total payout represented by step.  A value between _-1_ and _1_, e.g. _1_ = 100%, _0.5_ = 50%. A value of _0_ is treated as no coverage.","type":"number","format":"double"},"excessAmount":{"description":"Loss threshold that triggers step to pay out.\n\n- If less than or equal to _1_, percent of <<glossary:replacement cost value>> affected. \n- If greater than _1_ , monetary amount. ","type":"number","format":"double"},"isPerRiskSubject":{"description":"Determines if the payouts, deductibles, and calculations are _per risk_ (`Standard`) or _per building_ (`Step`). \n\n- If `Step`, terms (`payoutAmount` and `excessAmount`) are applied _per building_. If the step policy covers multiple locations that have a single building, the terms apply to each location. If the step policy covers multiple locations that each have multiple buildings, terms apply to each building separately.\n- If `Standard`, terms (`payoutAmount` and `excessAmount`) are applied _per risk_. Indicates that the terms apply to the total loss from all locations covered by the policy. If a single simple step is flagged as per risk, all other simple steps and interaction steps are considered per risk. ","type":"string","enum":["Standard","Step"]},"childOrderId":{"description":"Comma-separated list of `stepOrderId` values. Used in interaction steps to identify steps that are subject to the specified `subjectFuction`. _Not applicable to simple steps._","pattern":"^$|^([1-9][0-9]*)(,([1-9][0-9]*))*$","type":"string"},"subjectFunction":{"description":"Function used to calculate payout for steps identified in `childOrderId`. \n\n- If simple step, `None`.\n- If interaction step, one `Min`, `Max`, or `Sum` to identify the function applied to payout of `childOrderId` steps or to identify additional action on current step. ","type":"string","enum":["Max","Min","None","Sum"]},"coverageBase":{"description":"Loss type or coverages that can trigger payout. _Not applicable to interaction steps_.","type":"string","enum":["BI","BUILDING","BUILDING_AND_BI","BUILDING_AND_CONTENTS","BUILDING_AND_CONTENTS_AND_BI","BUILDING_OR_BI","BUILDING_OR_CONTENTS","BUILDING_OR_CONTENTS_OR_BI","CONTENTS","CONTENTS_AND_BI","CONTENTS_OR_BI","NOT_APPLICABLE"]},"limitGU":{"type":"string","description":"Scope of payment by step. Payment may be limited to <<glossary:ground up loss>>es. _Not applicable to interaction steps._","enum":["ACTUAL_PAYMENT_GU_LOSS_LIMITED","ACTUAL_PAYMENT_GU_LOSS_NOT_LIMITED","NOT_APPLICABLE"]},"uri":{"type":"string","readOnly":true}}},"UnderWriter":{"required":["underwriterName"],"type":"object","properties":{"underwriterId":{"description":"ID of underwriter.","type":"integer","format":"int32","readOnly":true,"example":45},"underwriterName":{"description":"Name of underwriter.","maxLength":30,"minLength":0,"type":"string","example":"TSR"},"uri":{"type":"string","readOnly":true,"example":"/platform/riskdata/v1/exposures/5/underwriters/45"}}},"CreateStepToolAnalysis":{"required":["resourceType","resourceUris","settings"],"type":"object","properties":{"resourceType":{"type":"string","enum":["analyses"]},"resourceUris":{"type":"array","items":{"type":"string","format":"uri","example":"/platform/riskdata/v1/analyses/5555"}},"settings":{"$ref":"#/components/schemas/StepToolSettings"}}},"StepToolSettings":{"required":["analysisNamePrefix","description","name"],"type":"object","properties":{"name":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"analysisNamePrefix":{"maxLength":64,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string"},"description":{"maxLength":80,"minLength":1,"pattern":"^\\w((?!--)[\\w\\s:-])*\\w$|^\\w*$","type":"string"},"eventSelectionId":{"minimum":1,"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"enableGrouping":{"type":"boolean"}}},"TenantDataJobResponse":{"type":"object","properties":{"jobId":{"type":"string"},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"status":{"type":"string","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string"},"startedAt":{"type":"string"},"endedAt":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"progress":{"type":"integer","format":"int32"},"entitlement":{"type":"string","description":"Licensed Intelligent Risk Platform program. One of `RI-EXPOSUREIQ`, `RI-RISKMODELER`, `RI-TREATYIQ`, `UNDERWRITEIQ`","example":"RI-RISKMODELER"},"resourceGroupId":{"type":"string","description":"ID of <<glossary:resource group>> to which job is allocated."},"details":{"$ref":"#/components/schemas/Details"},"jobUri":{"type":"string"}}},"ExposureBulkEdit":{"type":"object","properties":{"portfolios":{"type":"array","description":"List of operations for creating, updating, or deleting portfolios and associated accounts. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/PortfoliosBulkEdit"}},"accounts":{"type":"array","description":"List of operations for creating, updating, or deleting accounts and associated locations and policies. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/AccountsBulkEdit"}},"locations":{"type":"array","description":"List of operations for creating, updating, or deleting locations. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/LocationsBulkEdit"}},"policies":{"type":"array","description":"List of operations for creating, updating, or deleting policies. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/PoliciesBulkEdit"}},"stepPolicies":{"type":"array","description":"List of operations for creating, updating, or deleting step policies. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/StepPoliciesBulkEdit"}},"treaties":{"type":"array","description":"List of operations for creating, updating, or deleting step treaties. Required parameters depend on the operation type.","items":{"$ref":"#/components/schemas/TreatiesBulkEdit"}}}},"AccountsBulkEdit":{"required":["accountNumber"],"type":"object","properties":{"accountId":{"description":"ID of account.","type":"integer","format":"int32"},"accountName":{"description":"Name of account.","type":"string"},"accountNumber":{"description":"Number of account.","type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"underwriter":{"$ref":"#/components/schemas/UnderwriterInfo"},"branch":{"$ref":"#/components/schemas/BranchInfo"},"userId1":{"type":"string"},"userId2":{"type":"string"},"userId3":{"type":"string"},"userId4":{"type":"string"},"userText1":{"type":"string"},"userText2":{"type":"string"},"createDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"stampDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/PoliciesBulkEdit"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/LocationsBulkEdit"}},"stepPolicies":{"type":"array","items":{"$ref":"#/components/schemas/StepPoliciesBulkEdit"}},"errors":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","description":"List of tags to apply to account. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"AddressBulkEdit":{"type":"object","properties":{"addressId":{"type":"integer","format":"int32"},"area":{"$ref":"#/components/schemas/ExposureValue"},"buildingId":{"type":"string"},"buildingName":{"type":"string"},"addressType":{"$ref":"#/components/schemas/ExposureValue"},"country":{"$ref":"#/components/schemas/ExposureValue"},"countryScheme":{"type":"string"},"countryGeoId":{"type":"integer","format":"int32"},"countryRmsCode":{"type":"string"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"addressText":{"type":"string"},"streetAddress":{"type":"string"},"cityCode":{"type":"string"},"cityName":{"type":"string"},"cityGeoId":{"type":"integer","format":"int64"},"postalCode":{"type":"string"},"postalGeoId":{"type":"integer","format":"int64"},"block":{"type":"string"},"blockGroup":{"type":"string"},"locationCode":{"type":"string"},"locationCodeGeoId":{"type":"integer","format":"int64"},"parcelNumber":{"type":"string"},"subLocality":{"type":"string"},"geoResolutionConfidence":{"type":"number","format":"double"},"geoAccuracyBuffer":{"type":"number","format":"double"},"geoProductVersion":{"type":"string"},"geoLocationCode":{"type":"string"},"geoMatchCode":{"type":"string"},"geoDataSourceId":{"type":"integer","format":"int32"},"geoResolutionCode":{"$ref":"#/components/schemas/ExposureValue"},"geoDataSourceVersionId":{"type":"integer","format":"int32"},"geoDateTime":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"createDateTime":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"},"updateDateTime":{"type":"string"},"admin1Code":{"type":"string"},"admin1GeoId":{"type":"integer","format":"int64"},"admin1Name":{"type":"string"},"admin2Code":{"type":"string"},"admin2GeoId":{"type":"integer","format":"int64"},"admin2Name":{"type":"string"},"admin3Code":{"type":"string"},"admin3GeoId":{"type":"integer","format":"int64"},"admin3Name":{"type":"string"},"admin4Code":{"type":"string"},"admin4GeoId":{"type":"integer","format":"int64"},"admin4Name":{"type":"string"},"admin5Code":{"type":"string"},"admin5GeoId":{"type":"integer","format":"int64"},"admin5Name":{"type":"string"},"zone1GeoId":{"type":"integer","format":"int64"},"zone2GeoId":{"type":"integer","format":"int64"},"zone3GeoId":{"type":"integer","format":"int64"},"zone4GeoId":{"type":"integer","format":"int64"},"zone5GeoId":{"type":"integer","format":"int64"},"zone1":{"type":"string"},"zone2":{"type":"string"},"zone3":{"type":"string"},"zone3Name":{"type":"string"},"zone4Name":{"type":"string"},"zone5Name":{"type":"string"},"zone3Code":{"type":"string"},"zone4Code":{"type":"string"},"zone5Code":{"type":"string"},"ugid":{"type":"string"}}},"BuildingAttributeBulkEdit":{"required":["yearBuilt"],"type":"object","properties":{"buildingAttributeId":{"type":"integer","format":"int32"},"yearBuilt":{"type":"string","format":"yyyy","example":"2020"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"roofDeckType":{"$ref":"#/components/schemas/ExposureValue"},"roofDeckResistanceField":{"type":"number","format":"double"},"windowGlassdoorProtectionType":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorThickness":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorDoublepane":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorProtectionAdequacy":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverType":{"$ref":"#/components/schemas/ExposureValue"},"rooftopEquipment":{"$ref":"#/components/schemas/ExposureValue"},"skylightAreaPercent":{"type":"number","format":"double"},"dockDoorAreaPercent":{"type":"number","format":"double"},"dockDoorPressureResistance":{"type":"number","format":"double"},"skylightImpactResistance":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverResistanceCorner":{"type":"number","format":"double"},"roofSlope":{"$ref":"#/components/schemas/ExposureValue"},"flashingPulloutResistance":{"type":"number","format":"double"},"missileExposure":{"$ref":"#/components/schemas/ExposureValue"},"roofCoverResistancePerimeter":{"type":"number","format":"double"},"roofDeckResistancePerimeter":{"type":"number","format":"double"},"claddingPressureResistance":{"type":"number","format":"double"},"windowGlassdoorGlassType":{"$ref":"#/components/schemas/ExposureValue"},"claddingType":{"$ref":"#/components/schemas/ExposureValue"},"windowGlassdoorAreaPercent":{"type":"number","format":"double"},"roofDeckResistanceCorner":{"type":"number","format":"double"},"roofCoverResistanceField":{"type":"number","format":"double"},"roofArea":{"type":"number","format":"double"},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationBiDetailBulkEdit":{"type":"object","properties":{"locationBiDetailId":{"type":"integer","format":"int32"},"redundancy":{"$ref":"#/components/schemas/ExposureValue"},"siWaitingPeriod":{"type":"number","format":"double"},"siLimit":{"type":"number","format":"double"},"preparedness":{"$ref":"#/components/schemas/ExposureValue"},"serviceInterruption":{"$ref":"#/components/schemas/ExposureValue"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationConditionBulkEdit":{"type":"object","properties":{"locationId":{"type":"integer","format":"int32"},"conditionId":{"type":"integer","format":"int32"},"isIncluded":{"description":"Method of applying policy condition to location.\n\n- If `Included` policy condition applies to location.\n- If `NotIncluded`, policy condition does not apply to location.\n- If `UserIncluded`, policy condition is applied to location based on criteria or user input.","type":"string","enum":["NotIncluded","Included","UserIncluded"]},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationCoverageBulkEdit":{"type":"object","properties":{"waitingPeriod":{"type":"number","description":"BI waiting period; only applicable to BI coverage. Captured in number of days. Uses only single decimal place. By default, _0.0_.","format":"double"},"coverageId":{"type":"integer","format":"int32"},"label":{"description":"Label identified by `id`, `code`, and `name`.\n\n| `id` | `code` | `name`       |\n| ---- | ------ | ------------ |\n| 7    | EQ     | Building     |\n| 8    | EQ     | Contents     |\n| 9    | EQ     | BI           |\n| 28   | EQ     | Coverage A   |\n| 29   | EQ     | Coverage B   |\n| 30   | EQ     | Coverage C   |\n| 31   | EQ     | Coverage D   |\n| 50   | EQ     | Combined Cvg |\n| 14   | WS     | Building     |\n| 15   | WS     | Contents     |\n| 16   | WS     | BI           |\n| 24   | WS     | Coverage A   |\n| 25   | WS     | Coverage B   |\n| 26   | WS     | Coverage C   |\n| 27   | WS     | Coverage D   |\n| 51   | WS     | Combined Cvg |\n| 1    | TO     | Building     |\n| 10   | TR     | Building     |\n| 11   | TR     | Contents     |\n| 12   | TR     | BI           |\n| 44   | TR     | Coverage A   |\n| 45   | TR     | Coverage B   |\n| 46   | TR     | Coverage C   |\n| 47   | TR     | Coverage D   |\n| 55   | TR     | Combined Cvg |\n| 2    | TO     | Contents     |\n| 3    | TO     | BI           |\n| 32   | TO     | Coverage A   |\n| 33   | TO     | Coverage B   |\n| 34   | TO     | Coverage C   |\n| 35   | TO     | Coverage D   |\n| 52   | TO     | Combined Cvg |\n| 20   | FL     | Building     |\n| 21   | FL     | Contents     |\n| 22   | FL     | BI           |\n| 36   | FL     | Coverage A   |\n| 37   | FL     | Coverage B   |\n| 38   | FL     | Coverage C   |\n| 39   | FL     | Coverage D   |\n| 53   | FL     | Combined Cvg |\n| 4    | FR     | Building     |\n| 5    | FR     | Contents     |\n| 6    | FR     | B.I.         |\n| 40   | FR     | Coverage A   |\n| 41   | FR     | Coverage B   |\n| 42   | FR     | Coverage C   |\n| 43   | FR     | Coverage D   |\n| 54   | FR     | Combined Cvg |","$ref":"#/components/schemas/ExposureValue"},"eqslModifier":{"type":"integer","format":"int32","description":"Contents covered by EQSL (earthquake sprinkler leakage) subperil."},"lossType":{"type":"string","description":"Type of loss.","enum":["Building","Contents","BI","CombinedCvg"]},"percentSprinkler":{"description":"Percentage of contents under sprinkler.","type":"number","format":"double"},"value":{"type":"number","format":"double"},"biPoi":{"type":"number","format":"double","description":"BI period of indemnity. Not used in loss calculations.\n\nCaptured in number of months. Uses only a single decimal place. By default, `12.0`. "},"deductible":{"type":"number","description":"Amount of deductible.","format":"double"},"nonRankingDeductibleAmt":{"type":"number","description":"Value of deductible amount not applied to policy-level aggregate deductibles. ","format":"double"},"coverageModifier":{"type":"string","description":"Rating of content fragility; relevant to earthquakes (e.g. potential for building collapse).","example":"MODERATELY_DAMAGEABLE","enum":["DAMAGEABLE","HIGHLY_DAMAGEABLE","MODERATELY_DAMAGEABLE","SLIGHTLY_DAMAGEABLE","UNKNOWN_DAMAGEABLE"]},"accumulation":{"type":"string","description":"Type of accumulation.  ","example":"Building","enum":["Bi","Building","Combined","Contents"]},"limit":{"type":"number","format":"double","description":"Policy-level limit for total building, contents, or business interruption loss from all locations. Used in conjunction with a blanketLimit, policy-level limits are applied before the blanketLimit."},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss.","example":"EARTHQUAKE","enum":["EARTHQUAKE","WINDSTORM","TORNADO","FLOOD","FIRE","TERRORISM","WORKERSCOMP"]},"percentageLossDeductibleAmount":{"type":"number","description":"Deductible expressed as percentage of loss for coverage or combination of coverages. As loss increases, the deductible amount increases. Used to run HD models and accumulations.","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","example":"NO","enum":["YES","NO"]},"limitExtension":{"type":"number","description":"Extent of law and ordinance coverage.\n\n- Used for information in US hurricane regions. Not used in any loss calculations.\n- Used for financial model calculations in the North America Wildfire HD Models and Australia Bushfire HD Model.","format":"double"},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","description":"Type of operation.","readOnly":true,"enum":["DELETE","INSERT","UPDATE"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."}}},"LocationEqDetailBulkEdit":{"required":["completionDate","startDate","yearSprinkler","yearUpgrade"],"type":"object","properties":{"locationEqDetailId":{"type":"integer","format":"int32"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"yearSprinkler":{"type":"string","format":"yyyy","example":"2020"},"percentComplete":{"type":"number","format":"double"},"atcClass":{"type":"string"},"isoClass":{"type":"string"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"sicOccupancy":{"type":"string"},"ibcOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"eqslInsurance":{"$ref":"#/components/schemas/ExposureValue"},"secondarySupply":{"$ref":"#/components/schemas/ExposureValue"},"eqslSusceptibility":{"$ref":"#/components/schemas/ExposureValue"},"sprinklerType":{"$ref":"#/components/schemas/ExposureValue"},"baseIsolation":{"$ref":"#/components/schemas/ExposureValue"},"bldgExterior":{"$ref":"#/components/schemas/ExposureValue"},"cladding":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"ductility":{"$ref":"#/components/schemas/ExposureValue"},"duress":{"$ref":"#/components/schemas/ExposureValue"},"enggFoundation":{"$ref":"#/components/schemas/ExposureValue"},"frameBolt":{"$ref":"#/components/schemas/ExposureValue"},"hazardExposed":{"$ref":"#/components/schemas/ExposureValue"},"internalMasonaryPart":{"$ref":"#/components/schemas/ExposureValue"},"longSpan":{"$ref":"#/components/schemas/ExposureValue"},"mechElecEquip":{"$ref":"#/components/schemas/ExposureValue"},"ornamentation":{"$ref":"#/components/schemas/ExposureValue"},"overhangProfile":{"$ref":"#/components/schemas/ExposureValue"},"preFabrication":{"$ref":"#/components/schemas/ExposureValue"},"pounding":{"$ref":"#/components/schemas/ExposureValue"},"redundancy":{"$ref":"#/components/schemas/ExposureValue"},"shapeConfigure":{"$ref":"#/components/schemas/ExposureValue"},"shortColumn":{"$ref":"#/components/schemas/ExposureValue"},"sidingType":{"$ref":"#/components/schemas/ExposureValue"},"storyProfile":{"$ref":"#/components/schemas/ExposureValue"},"structureUpgrade":{"$ref":"#/components/schemas/ExposureValue"},"tank":{"$ref":"#/components/schemas/ExposureValue"},"tiltupRetrofit":{"$ref":"#/components/schemas/ExposureValue"},"torsion":{"$ref":"#/components/schemas/ExposureValue"},"urmRetrofit":{"$ref":"#/components/schemas/ExposureValue"},"wallsBrace":{"$ref":"#/components/schemas/ExposureValue"},"tsDebris":{"$ref":"#/components/schemas/ExposureValue"},"tsScour":{"$ref":"#/components/schemas/ExposureValue"},"tsSafeDist":{"$ref":"#/components/schemas/ExposureValue"},"tsProtect":{"$ref":"#/components/schemas/ExposureValue"},"eqPackage":{"$ref":"#/components/schemas/ExposureValue"},"eqProtect":{"$ref":"#/components/schemas/ExposureValue"},"eqSalvage":{"$ref":"#/components/schemas/ExposureValue"},"eqSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"urmChimney":{"$ref":"#/components/schemas/ExposureValue"},"builtOnSlope":{"$ref":"#/components/schemas/ExposureValue"},"alquistPreoloZone":{"type":"integer","format":"int32"},"soil":{"type":"number","format":"double"},"landslide":{"type":"number","format":"double"},"liquefaction":{"type":"number","format":"double"},"biZone":{"type":"integer","format":"int32"},"landslideMatch":{"$ref":"#/components/schemas/ExposureValue"},"liquefactionMatch":{"$ref":"#/components/schemas/ExposureValue"},"soilMatch":{"$ref":"#/components/schemas/ExposureValue"},"fireLossMatch":{"$ref":"#/components/schemas/ExposureValue"},"landslideCov":{"type":"number","format":"double"},"liquefactionCov":{"type":"number","format":"double"},"soilCov":{"type":"number","format":"double"},"fireLossCov":{"type":"number","format":"float","readOnly":true},"soilPeriod":{"type":"number","format":"double"},"soilThickness":{"type":"number","format":"double"},"fire1":{"type":"number","format":"double"},"fire2":{"type":"number","format":"double"},"fire3":{"type":"number","format":"double"},"fire4":{"type":"number","format":"double"},"fire5":{"type":"number","format":"double"},"fire6":{"type":"number","format":"double"},"fire7":{"type":"number","format":"double"},"fire8":{"type":"number","format":"double"},"mmi100":{"type":"number","format":"double"},"mmi200":{"type":"number","format":"double"},"mmi250":{"type":"number","format":"double"},"mmi475":{"type":"number","format":"double"},"avgSlope":{"type":"number","format":"double"},"distFault1":{"type":"number","format":"double"},"apMatch":{"$ref":"#/components/schemas/ExposureValue"},"mmiMatch":{"$ref":"#/components/schemas/ExposureValue"},"distSinkhole":{"type":"number","format":"double"},"distMine":{"type":"number","format":"double"},"sinkholeZone":{"type":"integer","format":"int32"},"soilVs":{"type":"number","format":"double"},"soilVsMatch":{"$ref":"#/components/schemas/ExposureValue"},"basinLocId":{"type":"integer","format":"int32"},"di":{"type":"number","format":"double"},"critd":{"type":"number","format":"double"},"n160CS":{"type":"number","format":"double"},"t15":{"type":"number","format":"double"},"wff":{"type":"number","format":"double"},"distriv":{"type":"number","format":"double"},"gwd":{"type":"number","format":"double"},"dc":{"type":"number","format":"double"},"liqcv":{"type":"number","format":"double"},"hdLiqMatch":{"$ref":"#/components/schemas/ExposureValue"},"phi":{"type":"number","format":"double"},"rough":{"type":"number","format":"double"},"ndvi":{"type":"number","format":"double"},"cohes":{"type":"number","format":"double"},"landcv":{"type":"number","format":"double"},"hdLandMatch":{"$ref":"#/components/schemas/ExposureValue"},"eqSlope":{"type":"number","format":"double"},"elev":{"type":"number","format":"double"},"cti":{"type":"number","format":"double"},"precip":{"type":"number","format":"double"},"topo":{"type":"number","format":"double"},"hdSecMatch":{"$ref":"#/components/schemas/ExposureValue"},"soilPeriodMatch":{"$ref":"#/components/schemas/ExposureValue"},"groundwaterDepthMatch":{"$ref":"#/components/schemas/ExposureValue"},"groundSlopeMatch":{"$ref":"#/components/schemas/ExposureValue"},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"mmi500":{"type":"number","format":"double","readOnly":true},"mmi1000":{"type":"number","format":"double","readOnly":true},"mmi1500":{"type":"number","format":"double","readOnly":true},"faultsName1":{"type":"string","readOnly":true},"faultsDistance1":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM601":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM651":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM701":{"type":"integer","format":"int32","readOnly":true},"faultsName2":{"type":"string","readOnly":true},"faultsDistance2":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM602":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM652":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM702":{"type":"integer","format":"int32","readOnly":true},"faultsName3":{"type":"string","readOnly":true},"faultsDistance3":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM603":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM653":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM703":{"type":"integer","format":"int32","readOnly":true},"faultsName4":{"type":"string","readOnly":true},"faultsDistance4":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM604":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM654":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM704":{"type":"integer","format":"int32","readOnly":true},"faultsName5":{"type":"string","readOnly":true},"faultsDistance5":{"type":"number","format":"double","readOnly":true},"faultsReturnPeriodM605":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM655":{"type":"integer","format":"int32","readOnly":true},"faultsReturnPeriodM705":{"type":"integer","format":"int32","readOnly":true},"faultsBackgroundRates":{"type":"string","readOnly":true},"mineName1":{"type":"string","readOnly":true},"mineType1":{"type":"string","readOnly":true},"mineStatus1":{"type":"string","readOnly":true},"mineArea1":{"type":"number","format":"double","readOnly":true},"mineDistance1":{"type":"number","format":"double","readOnly":true},"mineName2":{"type":"string","readOnly":true},"mineType2":{"type":"string","readOnly":true},"mineStatus2":{"type":"string","readOnly":true},"mineArea2":{"type":"number","format":"double","readOnly":true},"mineDistance2":{"type":"number","format":"double","readOnly":true},"mineName3":{"type":"string","readOnly":true},"mineType3":{"type":"string","readOnly":true},"mineStatus3":{"type":"string","readOnly":true},"mineArea3":{"type":"number","format":"double","readOnly":true},"mineDistance3":{"type":"number","format":"double","readOnly":true},"mineName4":{"type":"string","readOnly":true},"mineType4":{"type":"string","readOnly":true},"mineStatus4":{"type":"string","readOnly":true},"mineArea4":{"type":"number","format":"double","readOnly":true},"mineDistance4":{"type":"number","format":"double","readOnly":true},"mineName5":{"type":"string","readOnly":true},"mineType5":{"type":"string","readOnly":true},"mineStatus5":{"type":"string","readOnly":true},"mineArea5":{"type":"number","format":"double","readOnly":true},"mineDistance5":{"type":"number","format":"double","readOnly":true},"sinkHoleArea1":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance1":{"type":"number","format":"double","readOnly":true},"sinkHoleArea2":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance2":{"type":"number","format":"double","readOnly":true},"sinkHoleArea3":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance3":{"type":"number","format":"double","readOnly":true},"sinkHoleArea4":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance4":{"type":"number","format":"double","readOnly":true},"sinkHoleArea5":{"type":"number","format":"double","readOnly":true},"sinkHoleDistance5":{"type":"number","format":"double","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationFlDetailBulkEdit":{"required":["completionDate","panelDate","startDate","yearUpgrade"],"type":"object","properties":{"locationFlDetailId":{"type":"integer","format":"int32"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"floodProtect":{"$ref":"#/components/schemas/ExposureValue"},"floorType":{"$ref":"#/components/schemas/ExposureValue"},"floodMissile":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"duration":{"$ref":"#/components/schemas/ExposureValue"},"contamination":{"$ref":"#/components/schemas/ExposureValue"},"velocity":{"$ref":"#/components/schemas/ExposureValue"},"flPackage":{"$ref":"#/components/schemas/ExposureValue"},"flProtect":{"$ref":"#/components/schemas/ExposureValue"},"flSalvage":{"$ref":"#/components/schemas/ExposureValue"},"flSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"ifmVerticalExpDist":{"$ref":"#/components/schemas/ExposureValue"},"flFoundationType":{"$ref":"#/components/schemas/ExposureValue"},"ifmStructureCondition":{"$ref":"#/components/schemas/ExposureValue"},"bespokeFloodDefenseLevel":{"type":"number","format":"double"},"bespokeFloodDefenseLevelType":{"$ref":"#/components/schemas/ExposureValue"},"floodIndex":{"type":"number","format":"double"},"elevation":{"type":"number","format":"double"},"elevationCov":{"type":"number","format":"double"},"annProb":{"type":"string"},"flZone":{"type":"string"},"bfe":{"type":"string"},"additionalInfo":{"type":"string"},"panel":{"type":"string"},"cobra":{"type":"string"},"floodWay":{"type":"string"},"sfha":{"type":"string"},"community":{"type":"string"},"confidence":{"type":"number","format":"double"},"underRev":{"type":"string"},"panelDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"buffer":{"type":"number","format":"double"},"otherZones":{"type":"string"},"huZones":{"type":"string","readOnly":true},"mapSource":{"type":"integer","format":"int32"},"flMatch":{"$ref":"#/components/schemas/ExposureValue"},"finishedFloor":{"type":"number","format":"double"},"userId1":{"type":"string"},"userId2":{"type":"string"},"basinName":{"type":"string"},"catchmentId":{"type":"integer","format":"int32"},"floodDriver":{"type":"string"},"rms100Flzone":{"type":"integer","format":"int32"},"rms500Flzone":{"type":"integer","format":"int32"},"fl30YrRpDef":{"type":"integer","format":"int32"},"fl50YrRpDef":{"type":"integer","format":"int32"},"fl75YrRpDef":{"type":"integer","format":"int32"},"fl100YrRpDef":{"type":"integer","format":"int32"},"fl200YrRpDef":{"type":"integer","format":"int32"},"fl250YrRpDef":{"type":"integer","format":"int32"},"fl500YrRpDef":{"type":"integer","format":"int32"},"fl1000YrRpDef":{"type":"integer","format":"int32"},"fl10000YrRpDef":{"type":"integer","format":"int32"},"fl30YrRpUndef":{"type":"integer","format":"int32"},"fl50YrRpUndef":{"type":"integer","format":"int32"},"fl75YrRpUndef":{"type":"integer","format":"int32"},"fl100YrRpUndef":{"type":"integer","format":"int32"},"fl200YrRpUndef":{"type":"integer","format":"int32"},"fl250YrRpUndef":{"type":"integer","format":"int32"},"fl500YrRpUndef":{"type":"integer","format":"int32"},"fl1000YrRpUndef":{"type":"integer","format":"int32"},"fl10000YrRpUndef":{"type":"integer","format":"int32"},"hdFlMatch":{"$ref":"#/components/schemas/ExposureValue"},"flFfHag":{"type":"number","format":"double"},"flFfHagFlag":{"$ref":"#/components/schemas/ExposureValue"},"flZoneGroup":{"type":"integer","format":"int32"},"flPerBasement":{"type":"number","format":"double"},"protectedByLevee":{"type":"string"},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"fl10YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl30YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl50YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl100YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl200YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl250YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl500YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"fl1000YRInlandDepthUndef":{"type":"integer","format":"int32","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationFrDetailBulkEdit":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationFrDetailId":{"type":"integer","format":"int32"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"fireDepartmentRatingModifier":{"$ref":"#/components/schemas/ExposureValue"},"fireDepartmentRating":{"$ref":"#/components/schemas/ExposureValue"},"sprinklerSystem":{"$ref":"#/components/schemas/ExposureValue"},"remoteAlarm":{"$ref":"#/components/schemas/ExposureValue"},"frPackage":{"$ref":"#/components/schemas/ExposureValue"},"frProtect":{"$ref":"#/components/schemas/ExposureValue"},"frSalvage":{"$ref":"#/components/schemas/ExposureValue"},"frSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"frRoofCovering":{"$ref":"#/components/schemas/ExposureValue"},"frRoofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"frRoofAge":{"$ref":"#/components/schemas/ExposureValue"},"frRoofVent":{"$ref":"#/components/schemas/ExposureValue"},"frEmberAccumulator":{"$ref":"#/components/schemas/ExposureValue"},"frSuppression":{"$ref":"#/components/schemas/ExposureValue"},"frPerformance":{"$ref":"#/components/schemas/ExposureValue"},"frSetback":{"$ref":"#/components/schemas/ExposureValue"},"frExterior":{"$ref":"#/components/schemas/ExposureValue"},"frResAppurtenant":{"$ref":"#/components/schemas/ExposureValue"},"frComAppurtenant":{"$ref":"#/components/schemas/ExposureValue"},"frDeckType":{"$ref":"#/components/schemas/ExposureValue"},"frHeatResistance":{"$ref":"#/components/schemas/ExposureValue"},"frAccessibilityCondition":{"$ref":"#/components/schemas/ExposureValue"},"wildFireHazard":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSusceptibility":{"$ref":"#/components/schemas/ExposureValue"},"wildFireThreat":{"$ref":"#/components/schemas/ExposureValue"},"wildFireAreaDescription":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSurfaceFuelType":{"$ref":"#/components/schemas/ExposureValue"},"wildFireCommunityPreparedness":{"$ref":"#/components/schemas/ExposureValue"},"wildFireCommunityMatchFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmStructureCondition":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmMachineryEquipmentLocation":{"$ref":"#/components/schemas/ExposureValue"},"wildFireIfmSiteHazard":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSpecialConditions":{"type":"string"},"wildFireLocalHistory":{"type":"number","format":"double"},"wildFireNearbyHistory":{"type":"number","format":"double"},"wildFireAccessibility":{"$ref":"#/components/schemas/ExposureValue"},"wildFireMatch":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSlope":{"type":"integer","format":"int32"},"wildFireSlopeFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireFuel":{"$ref":"#/components/schemas/ExposureValue"},"wildFireFuelFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireDistanceToVeg":{"type":"integer","format":"int32"},"wildFireDistanceToVegFlag":{"$ref":"#/components/schemas/ExposureValue"},"wildFireDistanceToVegUnit":{"$ref":"#/components/schemas/ExposureValue"},"wildFireSiteHazVer":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"distanceToWuiIntermix":{"type":"integer","format":"int32","readOnly":true},"distanceToWuiInterface":{"type":"integer","format":"int32","readOnly":true},"stochasticBurnProb":{"type":"number","format":"double","readOnly":true},"urbanConFlagRationScore":{"type":"integer","format":"int32","readOnly":true},"distanceToCalFireVeryHigh":{"type":"number","format":"double","readOnly":true},"distanceToCalFireHigh":{"type":"number","format":"double","readOnly":true},"distanceToCalFireMedium":{"type":"number","format":"double","readOnly":true},"yearLastHistFire250m":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount250m":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount2km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount5km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount10km":{"type":"integer","format":"int32","readOnly":true},"histFireYearCount20km":{"type":"integer","format":"int32","readOnly":true},"fireStationName1":{"type":"string","readOnly":true},"fireStationLatitude1":{"type":"number","format":"double","readOnly":true},"fireStationLongitude1":{"type":"number","format":"double","readOnly":true},"fireStationDistance1":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress1":{"type":"string","readOnly":true},"fireStationCityName1":{"type":"string","readOnly":true},"fireStationPostalCode1":{"type":"string","readOnly":true},"fireStationAdmin2name1":{"type":"string","readOnly":true},"fireStationAdmin1code1":{"type":"string","readOnly":true},"fireStationLevel1":{"type":"string","readOnly":true},"fireStationEms1":{"type":"string","readOnly":true},"fireStationType1":{"type":"string","readOnly":true},"fireStationName2":{"type":"string","readOnly":true},"fireStationLatitude2":{"type":"number","format":"double","readOnly":true},"fireStationLongitude2":{"type":"number","format":"double","readOnly":true},"fireStationDistance2":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress2":{"type":"string","readOnly":true},"fireStationCityName2":{"type":"string","readOnly":true},"fireStationPostalCode2":{"type":"string","readOnly":true},"fireStationAdmin2name2":{"type":"string","readOnly":true},"fireStationAdmin1code2":{"type":"string","readOnly":true},"fireStationLevel2":{"type":"string","readOnly":true},"fireStationEms2":{"type":"string","readOnly":true},"fireStationType2":{"type":"string","readOnly":true},"fireStationName3":{"type":"string","readOnly":true},"fireStationLatitude3":{"type":"number","format":"double","readOnly":true},"fireStationLongitude3":{"type":"number","format":"double","readOnly":true},"fireStationDistance3":{"type":"number","format":"double","readOnly":true},"fireStationStreetaddress3":{"type":"string","readOnly":true},"fireStationCityname3":{"type":"string","readOnly":true},"fireStationPostalcode3":{"type":"string","readOnly":true},"fireStationAdmin2name3":{"type":"string","readOnly":true},"fireStationAdmin1code3":{"type":"string","readOnly":true},"fireStationLevel3":{"type":"string","readOnly":true},"fireStationEms3":{"type":"string","readOnly":true},"fireStationType3":{"type":"string","readOnly":true},"fireStationName4":{"type":"string","readOnly":true},"fireStationLatitude4":{"type":"number","format":"double","readOnly":true},"fireStationLongitude4":{"type":"number","format":"double","readOnly":true},"fireStationDistance4":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress4":{"type":"string","readOnly":true},"fireStationCityName4":{"type":"string","readOnly":true},"fireStationPostalCode4":{"type":"string","readOnly":true},"fireStationAdmin2name4":{"type":"string","readOnly":true},"fireStationAdmin1code4":{"type":"string","readOnly":true},"fireStationLevel4":{"type":"string","readOnly":true},"fireStationEms4":{"type":"string","readOnly":true},"fireStationType4":{"type":"string","readOnly":true},"fireStationName5":{"type":"string","readOnly":true},"fireStationLatitude5":{"type":"number","format":"double","readOnly":true},"fireStationLongitude5":{"type":"number","format":"double","readOnly":true},"fireStationDistance5":{"type":"number","format":"double","readOnly":true},"fireStationStreetAddress5":{"type":"string","readOnly":true},"fireStationCityName5":{"type":"string","readOnly":true},"fireStationPostalcode5":{"type":"string","readOnly":true},"fireStationAdmin2name5":{"type":"string","readOnly":true},"fireStationAdmin1code5":{"type":"string","readOnly":true},"fireStationLevel5":{"type":"string","readOnly":true},"fireStationEms5":{"type":"string","readOnly":true},"fireStationType5":{"type":"string","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationToDetailBulkEdit":{"required":["yearUpgrade"],"type":"object","properties":{"locationToDetailId":{"type":"integer","format":"int32"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"percentComplete":{"type":"number","format":"double"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"architecture":{"$ref":"#/components/schemas/ExposureValue"},"cladRate":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"designCode":{"$ref":"#/components/schemas/ExposureValue"},"doorOpenings":{"$ref":"#/components/schemas/ExposureValue"},"externalOrnament":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"maintenance":{"$ref":"#/components/schemas/ExposureValue"},"mechElecSide":{"$ref":"#/components/schemas/ExposureValue"},"otherOpenings":{"$ref":"#/components/schemas/ExposureValue"},"roofAge":{"$ref":"#/components/schemas/ExposureValue"},"roofAnchor":{"$ref":"#/components/schemas/ExposureValue"},"roofEquipment":{"$ref":"#/components/schemas/ExposureValue"},"roofFrame":{"$ref":"#/components/schemas/ExposureValue"},"roofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"roofParpet":{"$ref":"#/components/schemas/ExposureValue"},"roofSystem":{"$ref":"#/components/schemas/ExposureValue"},"windMissile":{"$ref":"#/components/schemas/ExposureValue"},"windVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"floodMissiles":{"$ref":"#/components/schemas/ExposureValue"},"floodProtection":{"$ref":"#/components/schemas/ExposureValue"},"iceDamProtection":{"$ref":"#/components/schemas/ExposureValue"},"plumbingInsulation":{"$ref":"#/components/schemas/ExposureValue"},"atticInsulation":{"$ref":"#/components/schemas/ExposureValue"},"roofVentilation":{"$ref":"#/components/schemas/ExposureValue"},"snowGuards":{"$ref":"#/components/schemas/ExposureValue"},"treeDensity":{"$ref":"#/components/schemas/ExposureValue"},"garaging":{"$ref":"#/components/schemas/ExposureValue"},"toPackage":{"$ref":"#/components/schemas/ExposureValue"},"toProtect":{"$ref":"#/components/schemas/ExposureValue"},"toSalvage":{"$ref":"#/components/schemas/ExposureValue"},"toSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"dominantSubperilCS":{"type":"integer","format":"int64","readOnly":true},"percentInGeographyCS":{"type":"number","format":"double","readOnly":true},"score1CS":{"type":"integer","format":"int32","readOnly":true},"score2CS":{"type":"integer","format":"int32","readOnly":true},"score3CS":{"type":"integer","format":"int32","readOnly":true},"scoreOverallCS":{"type":"integer","format":"int32","readOnly":true},"dominantSubperilWT":{"type":"integer","format":"int64","readOnly":true},"percentInGeographyWT":{"type":"number","format":"double","readOnly":true},"score1WT":{"type":"integer","format":"int32","readOnly":true},"score2WT":{"type":"integer","format":"int32","readOnly":true},"score3WT":{"type":"integer","format":"int32","readOnly":true},"scoreOverallWT":{"type":"integer","format":"int32","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationTrDetailBulkEdit":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationTrDetailId":{"type":"integer","format":"int32"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"trPackage":{"$ref":"#/components/schemas/ExposureValue"},"trProtect":{"$ref":"#/components/schemas/ExposureValue"},"trSalvage":{"$ref":"#/components/schemas/ExposureValue"},"trSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"score1":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"targetsName1":{"type":"string","readOnly":true},"targetsId1":{"type":"integer","format":"int32","readOnly":true},"targetsScore1":{"type":"number","format":"double","readOnly":true},"targetsDistance1":{"type":"number","format":"double","readOnly":true},"targetsCategory1":{"type":"number","format":"double","readOnly":true},"targetsCityName1":{"type":"string","readOnly":true},"targetsAdmin1code1":{"type":"string","readOnly":true},"targetsName2":{"type":"string","readOnly":true},"targetsId2":{"type":"integer","format":"int32","readOnly":true},"targetsScore2":{"type":"number","format":"double","readOnly":true},"targetsDistance2":{"type":"number","format":"double","readOnly":true},"targetsCategory2":{"type":"number","format":"double","readOnly":true},"targetsCityName2":{"type":"string","readOnly":true},"targetsAdmin1code2":{"type":"string","readOnly":true},"targetsName3":{"type":"string","readOnly":true},"targetsId3":{"type":"integer","format":"int32","readOnly":true},"targetsScore3":{"type":"number","format":"double","readOnly":true},"targetsDistance3":{"type":"number","format":"double","readOnly":true},"targetsCategory3":{"type":"number","format":"double","readOnly":true},"targetsCityName3":{"type":"string","readOnly":true},"targetsAdmin1code3":{"type":"string","readOnly":true},"targetsName4":{"type":"string","readOnly":true},"targetsId4":{"type":"integer","format":"int32","readOnly":true},"targetsScore4":{"type":"number","format":"double","readOnly":true},"targetsDistance4":{"type":"number","format":"double","readOnly":true},"targetsCategory4":{"type":"number","format":"double","readOnly":true},"targetsCityName4":{"type":"string","readOnly":true},"targetsAdmin1code4":{"type":"string","readOnly":true},"targetsName5":{"type":"string","readOnly":true},"targetsId5":{"type":"integer","format":"int32","readOnly":true},"targetsScore5":{"type":"number","format":"double","readOnly":true},"targetsDistance5":{"type":"number","format":"double","readOnly":true},"targetsCategory5":{"type":"number","format":"double","readOnly":true},"targetsCityName5":{"type":"string","readOnly":true},"targetsAdmin1code5":{"type":"string","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationWcDetailBulkEdit":{"type":"object","properties":{"locationWcDetailId":{"type":"integer","format":"int32"},"totalPayroll":{"type":"number","format":"double"},"totalNumEmployees":{"type":"number","format":"double"},"numEmployeesShift1":{"type":"number","format":"double"},"numEmployeesShift2":{"type":"number","format":"double"},"numEmployeesShift3":{"type":"number","format":"double"},"numEmployeesShift4":{"type":"number","format":"double"},"calcNumEmployees":{"type":"number","format":"double"},"emergencyProtection":{"$ref":"#/components/schemas/ExposureValue"},"hazardousMaterials":{"$ref":"#/components/schemas/ExposureValue"},"wageRelativity":{"$ref":"#/components/schemas/ExposureValue"},"riskManagement":{"$ref":"#/components/schemas/ExposureValue"},"employeeDensity":{"$ref":"#/components/schemas/ExposureValue"},"uslh":{"type":"boolean"},"excessComp":{"$ref":"#/components/schemas/ExposureValue"},"undMngtAdjustment":{"type":"number","format":"double"},"groupNum":{"type":"string"},"groupName":{"type":"string"},"occupancyTypeScheme":{"$ref":"#/components/schemas/ExposureValue"},"occupancyType":{"$ref":"#/components/schemas/ExposureValue"},"maxEmployees":{"type":"number","format":"double"},"shiftType":{"$ref":"#/components/schemas/ExposureValue"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationWsDetailBulkEdit":{"required":["completionDate","startDate","yearUpgrade"],"type":"object","properties":{"locationWsDetailId":{"type":"integer","format":"int32"},"yearUpgrade":{"type":"string","format":"yyyy","example":"2020"},"startDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"completionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"percentComplete":{"type":"number","format":"double"},"coastalSegment":{"type":"string"},"fireClass":{"type":"string"},"rmsClass":{"type":"string"},"userClass":{"type":"string"},"atcOccupancy":{"type":"string"},"isoOccupancy":{"type":"string"},"sicOccupancy":{"type":"string"},"ibcOccupancy":{"type":"string"},"userOccupancy":{"type":"string"},"siteLimit":{"type":"number","format":"double"},"siteDeduct":{"type":"number","format":"double"},"combinedLimit":{"type":"number","format":"double"},"combinedDeduct":{"type":"number","format":"double"},"nonRankingCombinedDeduct":{"type":"number","format":"double"},"nonRankingSiteDeductible":{"type":"number","format":"double"},"percentageSiteLossDeductibleAmount":{"type":"number","format":"double"},"percentageCombinedLossDeductibleAmount":{"type":"number","format":"double"},"isFranchiseSiteDeductible":{"type":"string","enum":["YES","NO"]},"isFranchiseCombinedDeductible":{"type":"string","enum":["YES","NO"]},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"architecture":{"$ref":"#/components/schemas/ExposureValue"},"cladRate":{"$ref":"#/components/schemas/ExposureValue"},"cladType":{"$ref":"#/components/schemas/ExposureValue"},"constructQuality":{"$ref":"#/components/schemas/ExposureValue"},"designCode":{"$ref":"#/components/schemas/ExposureValue"},"doorOpenings":{"$ref":"#/components/schemas/ExposureValue"},"externalOrnament":{"$ref":"#/components/schemas/ExposureValue"},"floodVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"foundation":{"$ref":"#/components/schemas/ExposureValue"},"maintenance":{"$ref":"#/components/schemas/ExposureValue"},"mechElecSide":{"$ref":"#/components/schemas/ExposureValue"},"otherOpenings":{"$ref":"#/components/schemas/ExposureValue"},"roofAge":{"$ref":"#/components/schemas/ExposureValue"},"roofAnchor":{"$ref":"#/components/schemas/ExposureValue"},"roofEquipment":{"$ref":"#/components/schemas/ExposureValue"},"roofFrame":{"$ref":"#/components/schemas/ExposureValue"},"roofGeometry":{"$ref":"#/components/schemas/ExposureValue"},"roofParpet":{"$ref":"#/components/schemas/ExposureValue"},"roofSystem":{"$ref":"#/components/schemas/ExposureValue"},"windMissile":{"$ref":"#/components/schemas/ExposureValue"},"windVulnerability":{"$ref":"#/components/schemas/ExposureValue"},"floodMissiles":{"$ref":"#/components/schemas/ExposureValue"},"floodProtection":{"$ref":"#/components/schemas/ExposureValue"},"basement":{"$ref":"#/components/schemas/ExposureValue"},"mechElecGround":{"$ref":"#/components/schemas/ExposureValue"},"flashing":{"$ref":"#/components/schemas/ExposureValue"},"ifmVerticalExpDist":{"$ref":"#/components/schemas/ExposureValue"},"ifmStructCondition":{"$ref":"#/components/schemas/ExposureValue"},"ifmEquipBracing":{"$ref":"#/components/schemas/ExposureValue"},"ifmMissileExp":{"$ref":"#/components/schemas/ExposureValue"},"wsPackage":{"$ref":"#/components/schemas/ExposureValue"},"wsProtect":{"$ref":"#/components/schemas/ExposureValue"},"wsSalvage":{"$ref":"#/components/schemas/ExposureValue"},"wsSpecieStorage":{"$ref":"#/components/schemas/ExposureValue"},"resistGarage":{"$ref":"#/components/schemas/ExposureValue"},"wsFloorType":{"$ref":"#/components/schemas/ExposureValue"},"wsFoundationType":{"$ref":"#/components/schemas/ExposureValue"},"contamination":{"$ref":"#/components/schemas/ExposureValue"},"floodDuration":{"$ref":"#/components/schemas/ExposureValue"},"garaging":{"$ref":"#/components/schemas/ExposureValue"},"treeDensity":{"$ref":"#/components/schemas/ExposureValue"},"depreciationAge":{"$ref":"#/components/schemas/ExposureValue"},"velocity":{"$ref":"#/components/schemas/ExposureValue"},"floodIndex":{"type":"number","format":"double"},"distToCoast":{"type":"number","format":"double"},"sysDistToCoast":{"type":"number","format":"double"},"elevation":{"type":"number","format":"double"},"manMadeCov":{"type":"number","format":"double"},"naturalCov":{"type":"number","format":"double"},"elevationCov":{"type":"number","format":"double"},"distToCoastCov":{"type":"number","format":"double"},"manMadeRoughness":{"type":"integer","format":"int32"},"naturalRoughness":{"type":"integer","format":"int32"},"windPool":{"type":"integer","format":"int32"},"biZone":{"type":"integer","format":"int32"},"topologyFeature":{"type":"integer","format":"int32"},"elevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"naturalRoughnessMatch":{"$ref":"#/components/schemas/ExposureValue"},"manMadeRoughnessMatch":{"$ref":"#/components/schemas/ExposureValue"},"distToCoastMatch":{"$ref":"#/components/schemas/ExposureValue"},"windPoolMatch":{"$ref":"#/components/schemas/ExposureValue"},"windExposure":{"type":"integer","format":"int32"},"nfipRate":{"type":"number","format":"double"},"nfipYear":{"type":"integer","format":"int32"},"nfipYearMatch":{"$ref":"#/components/schemas/ExposureValue"},"buildingElevation":{"type":"number","format":"double"},"buildingElevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"rmsBuildingElevation":{"type":"number","format":"double"},"rmsBuildingElevationMatch":{"$ref":"#/components/schemas/ExposureValue"},"zoneGroup":{"type":"integer","format":"int32"},"perBasement":{"type":"number","format":"double"},"percentInGeography":{"type":"number","format":"double","readOnly":true},"score1":{"type":"integer","format":"int32","readOnly":true},"score2":{"type":"integer","format":"int32","readOnly":true},"score3":{"type":"integer","format":"int32","readOnly":true},"scoreOverall":{"type":"integer","format":"int32","readOnly":true},"windpoolZone":{"type":"string","readOnly":true},"distanceToInnerCoast":{"type":"number","format":"double","readOnly":true},"ws1YrRpWind":{"type":"number","format":"double","readOnly":true},"ws2YrRpWind":{"type":"number","format":"double","readOnly":true},"ws5YrRpWind":{"type":"number","format":"double","readOnly":true},"ws10YrRpWind":{"type":"number","format":"double","readOnly":true},"ws25YrRpWind":{"type":"number","format":"double","readOnly":true},"ws50YrRpWind":{"type":"number","format":"double","readOnly":true},"ws100YrRpWind":{"type":"number","format":"double","readOnly":true},"ws200YrRpWind":{"type":"number","format":"double","readOnly":true},"ws250YrRpWind":{"type":"number","format":"double","readOnly":true},"ws500YrRpWind":{"type":"number","format":"double","readOnly":true},"ws1000YrRpWind":{"type":"number","format":"double","readOnly":true},"ws10000YrRpWind":{"type":"number","format":"double","readOnly":true},"ws1YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws2YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws5YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws10YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws25YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws50YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws100YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws200YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws250YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws500YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws1000YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"ws10000YrRpSurgeDef":{"type":"number","format":"double","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"LocationsBulkEdit":{"required":["address","property"],"type":"object","properties":{"property":{"$ref":"#/components/schemas/Property"},"address":{"$ref":"#/components/schemas/AddressBulkEdit"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"tiv":{"type":"number","format":"double","description":"Replacment cost (total insurable value) of <<glossary:location coverage>> values for buildings, building contents, and business interruptions at location."},"riskAssessorCurves":{"type":"string"},"maxCvgBldgValuation":{"type":"number","format":"double"},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"locationBiDetail":{"$ref":"#/components/schemas/LocationBiDetailBulkEdit"},"locationEqDetail":{"$ref":"#/components/schemas/LocationEqDetailBulkEdit"},"locationWsDetail":{"$ref":"#/components/schemas/LocationWsDetailBulkEdit"},"locationToDetail":{"$ref":"#/components/schemas/LocationToDetailBulkEdit"},"locationFlDetail":{"$ref":"#/components/schemas/LocationFlDetailBulkEdit"},"locationFrDetail":{"$ref":"#/components/schemas/LocationFrDetailBulkEdit"},"locationTrDetail":{"$ref":"#/components/schemas/LocationTrDetailBulkEdit"},"buildingAttribute":{"$ref":"#/components/schemas/BuildingAttributeBulkEdit"},"locationCoverages":{"type":"array","items":{"$ref":"#/components/schemas/LocationCoverageBulkEdit"}},"reinsuranceCessions":{"type":"array","items":{"$ref":"#/components/schemas/ReinsuranceCessionDetailBulkEdit"}},"locationWcDetails":{"type":"array","items":{"$ref":"#/components/schemas/LocationWcDetailBulkEdit"}},"locationConditions":{"type":"array","items":{"$ref":"#/components/schemas/LocationConditionBulkEdit"}},"errors":{"type":"array","readOnly":true,"items":{"type":"string"}}}},"LossOccurrenceBulkEdit":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"treatyId":{"type":"integer","format":"int32","description":"ID of treaty."},"uri":{"type":"string","readOnly":true},"regionPeril":{"$ref":"#/components/schemas/ExposureValue"},"lossOccurrenceTime":{"type":"integer","format":"int32"},"lossOccurrenceRadius":{"type":"integer","format":"int32"},"radiusUnit":{"$ref":"#/components/schemas/ExposureValue"},"multiLossOccurrence":{"$ref":"#/components/schemas/ExposureValue"}}},"PoliciesBulkEdit":{"required":["policyNumber","status"],"type":"object","properties":{"policyId":{"type":"integer","description":"ID of policy.","format":"int32"},"policyNumber":{"description":"Number of policy.","type":"string"},"accountId":{"description":"ID of account.","type":"integer","format":"int32"},"lob":{"$ref":"#/components/schemas/LineOfBusinessInfo"},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss.","example":"EARTHQUAKE","enum":["EARTHQUAKE","WINDSTORM","TORNADO","FLOOD","FIRE","TERRORISM","WORKERSCOMP"]},"status":{"type":"string","enum":["Booked","Cancelled","Expired","Multiple","Pending","Quote","Unknown","What_if"]},"inceptionDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"expirationDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"partOf":{"type":"number","format":"double"},"attachmentPoint":{"type":"number","description":"Amount at which the occurrence layer begins to take loss.","format":"double"},"minDeductible":{"type":"number","format":"double"},"maxDeductible":{"type":"number","format":"double"},"blanketLimit":{"type":"number","format":"double"},"blanketDeductible":{"type":"number","format":"double"},"blanketPremium":{"type":"number","format":"double"},"biLifeLine":{"description":"Not used. Retained for legacy purposes.","type":"integer","format":"int32"},"deductType":{"description":"Not used. Retained for legacy purposes.","type":"integer","format":"int32"},"structure":{"type":"string","enum":["Standard","Step"]},"coverageBase":{"type":"string","description":"Loss type or coverages that can trigger payout. Not applicable to interaction steps.","enum":["BUILDING","CONTENTS_OR_BI","BUILDING_OR_CONTENTS_OR_BI","CONTENTS","BI","BUILDING_AND_CONTENTS","BUILDING_AND_BI","CONTENTS_AND_BI","BUILDING_AND_CONTENTS_AND_BI","BUILDING_OR_CONTENTS","BUILDING_OR_BI","NOT_APPLICABLE"]},"limitGU":{"type":"string","enum":["ACTUAL_PAYMENT_GU_LOSS_LIMITED","ACTUAL_PAYMENT_GU_LOSS_NOT_LIMITED","NOT_APPLICABLE"]},"userText1":{"type":"string"},"userText2":{"type":"string"},"userText3":{"type":"string"},"userText4":{"type":"string"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"newCauseOfLoss":{"type":"string","enum":["NONE","EARTHQUAKE","WINDSTORM","SEVERE_CONVECTIVE_STORM","FLOOD","FIRE","WIND","WATER","WIND_AND_WATER","TERRORISM","TERRORISM_CONVENTIONAL_ONLY","TERRORISM_CBRN_ONLY"]},"percentOfLossDeductible":{"description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","enum":["YES","NO"]},"aggregateMinDeductible":{"description":"Amount of minimum aggregate deductible for standard policies. No payout occurs until this deductible is satisfied. Lower level deductibles, (e.g., site deductibles) erode this policy-level term. HD models only.","type":"number","format":"double"},"aggregateMaxDeductible":{"type":"number","description":"Amount of maximum aggregate deductible for standard policies.","format":"double"},"aggregateLimit":{"type":"number","description":"Minimum aggregate deductible amount.","format":"double"},"uri":{"type":"string","readOnly":true},"coverages":{"type":"array","items":{"$ref":"#/components/schemas/PolicyCoverageBulkEdit"}},"reinsuranceCessions":{"type":"array","items":{"$ref":"#/components/schemas/ReinsuranceCessionDetailBulkEdit"}},"policyConditions":{"type":"array","items":{"$ref":"#/components/schemas/PolicyConditionBulkEdit"}},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"errors":{"type":"array","readOnly":true,"items":{"type":"string"}}}},"PolicyConditionBulkEdit":{"required":["policyConditionName"],"type":"object","properties":{"policyConditionId":{"description":"ID of policy condition.","type":"integer","format":"int32"},"policyConditionName":{"description":"Name of policy condition.","maxLength":40,"minLength":1,"type":"string"},"isPredefined":{"description":"If `true`, policy condition is predefined. If `false`, policy condition is ad-hoc.","type":"boolean"},"limit":{"description":"Total coverage amount provided by the condition. Is multiplied by insurer's pro-rata participation to determine their exposure.","type":"number","format":"double"},"deductible":{"description":"Deductible associated with the condition. Values <= 1 are interpreted as percentages; values > 1 are interpreted as flat amounts. By default, `0`.","type":"number","format":"double"},"deductibleType":{"description":"Type of deductible. ","type":"string","enum":["DEFAULT"]},"conditionType":{"description":"Type of condition. If `POLICY_RESTRICTION`, condition restricts all policy coverage to specific locations. If `SUBLIMIT`, condition limits coverage to a subset of locations.","type":"string","enum":["POLICY_RESTRICTION","SUBLIMIT"]},"parentCondition":{"description":"ID of parent condition when the policy condition is a sub-condition.","$ref":"#/components/schemas/ExposureValue"},"policyNumber":{"description":"Number of policy.","type":"string","readOnly":true},"policyConditionCriterias":{"description":"Query for selecting applicable locations based on location property values. Supports compound queries that use logical operators.\n\nPolicy condition may be applied to location based on this query.","type":"array","items":{"$ref":"#/components/schemas/PolicyConditionCriteria"}},"percentOfLossDeductibleAmount":{"description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","enum":["YES","NO"]},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"PolicyCoverageBulkEdit":{"required":["label","lossType","peril"],"type":"object","properties":{"policyCoverageId":{"type":"integer","format":"int32"},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss.","example":"EARTHQUAKE","enum":["EARTHQUAKE","WINDSTORM","TORNADO","FLOOD","FIRE","TERRORISM","WORKERSCOMP"]},"lossType":{"type":"string","enum":["Building","Contents","BI","CombinedCvg"]},"premium":{"type":"number","format":"double"},"limit":{"type":"number","format":"double"},"deductible":{"type":"number","format":"double"},"label":{"$ref":"#/components/schemas/ExposureValue"},"accumulation":{"type":"integer","format":"int32"},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"percentOfLossDeductibleAmount":{"description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases.","type":"number","format":"double"},"isFranchiseDeductible":{"description":"If `YES`, deductible is franchise. If `NO`, deductible is conventional.","type":"string","enum":["YES","NO"]},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"PortfoliosBulkEdit":{"required":["description","portfolioName","portfolioNumber"],"type":"object","properties":{"portfolioId":{"description":"ID of portfolio.","type":"integer","format":"int32"},"portfolioName":{"description":"Name of portfolio.","maxLength":40,"minLength":0,"type":"string"},"portfolioNumber":{"description":"Number of portfolio.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of portfolio.","maxLength":255,"minLength":0,"type":"string"},"createDate":{"type":"string","readOnly":true,"description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`"},"stampDate":{"type":"string","description":"Timestamp in [8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`","readOnly":true},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountsBulkEdit"}},"errors":{"type":"array","readOnly":true,"items":{"type":"string"}},"tagIds":{"type":"array","description":"List of tags to apply to account. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}},"ReinsuranceCessionDetailBulkEdit":{"required":["type"],"type":"object","properties":{"reinsuranceCessionId":{"type":"integer","format":"int32"},"reinsuranceCessionName":{"type":"string"},"exposureResourceId":{"description":"ID of analyzed exposure resource.","type":"integer","format":"int32","example":26113,"readOnly":true},"exposureResourceType":{"type":"string","readOnly":true,"enum":["POL","LOC"]},"type":{"type":"string","enum":["None","Facultative","Treaty"]},"facReinsurer":{"description":"Identifies the facultative insurer, the entity to which the cession is made. Required if `type` is `Facultative`.","$ref":"#/components/schemas/FacReinsurer"},"layerNumber":{"type":"integer","format":"int32","description":"Number of reinsurance layer."},"layerAmount":{"minimum":0,"type":"number","format":"double","description":"Total value of insurance for the entire reinsurance layer. "},"excessAmount":{"minimum":0,"type":"number","format":"double","description":"Loss level at which the reinsurance layer is liable."},"percentReinsurance":{"minimum":0,"type":"number","format":"double","description":"Reinsurer's participating percentage of the entire reinsurance layer."},"maolAmount":{"description":"Maximum Any One Life Amount","type":"number","format":"double"},"priority":{"type":"integer","format":"int32","description":"Inuring priority of reinsurance. Priority _1_ treaties take loss first. Subsequent numbers take subsequent losses."},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"uri":{"type":"string","description":"URI of reinsurance cession.","readOnly":true},"treaty":{"description":"Identifies treaty cession. Required if `type` is `Treaty`.","$ref":"#/components/schemas/Treaty"},"operationType":{"type":"string","readOnly":true,"enum":["INSERT","UPDATE","DELETE"]}}},"StepPoliciesBulkEdit":{"required":["expirationDate","inceptionDate","stepPolicyNumber"],"type":"object","properties":{"stepPolicyId":{"type":"integer","format":"int32"},"accountId":{"description":"ID of account.","minimum":1,"type":"integer","format":"int32"},"stepPolicyNumber":{"maxLength":50,"minLength":1,"type":"string"},"stepPolicyName":{"maxLength":50,"minLength":0,"type":"string"},"stepOrderId":{"type":"integer","format":"int32"},"lob":{"description":"Type of business covered (e.g., fire, commercial, personal, auto, or residence).\n\nDetermines level of output if the granularity specified in output profile is based on the LOB  (e.g. `Cresta by LOB`). If multiple `lobId`s are specified, the lowest `lobId` is used. Not applicable to interaction steps.","$ref":"#/components/schemas/LineOfBusinessInfo"},"causeOfLoss":{"type":"string","enum":["EARTHQUAKE","FIRE","FLOOD","NONE","SEVERE_CONVECTIVE_STORM","TERRORISM","TERRORISM_CBRN_ONLY","TERRORISM_CONVENTIONAL_ONLY","WATER","WIND","WINDSTORM","WIND_AND_WATER"]},"inceptionDate":{"type":"string"},"expirationDate":{"type":"string"},"payoutAmount":{"type":"number","format":"double"},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"payoutFunction":{"type":"string","enum":["Standard","Step"]},"share":{"type":"number","format":"double"},"excessAmount":{"type":"number","format":"double"},"isPerRiskSubject":{"type":"string","enum":["Standard","Step"]},"childOrderId":{"pattern":"^$|^([1-9][0-9]*)(,([1-9][0-9]*))*$","type":"string"},"subjectFunction":{"type":"string","enum":["None","Min","Max","Sum"]},"coverageBase":{"type":"string","description":"Loss type or coverages that can trigger payout. Not applicable to interaction steps.","enum":["BUILDING","CONTENTS_OR_BI","BUILDING_OR_CONTENTS_OR_BI","CONTENTS","BI","BUILDING_AND_CONTENTS","BUILDING_AND_BI","CONTENTS_AND_BI","BUILDING_AND_CONTENTS_AND_BI","BUILDING_OR_CONTENTS","BUILDING_OR_BI","NOT_APPLICABLE"]},"limitGU":{"type":"string","description":"Scope of payment by step. Payment may be limited to <<glossary:ground up loss>>es. Not applicable interaction steps.","enum":["ACTUAL_PAYMENT_GU_LOSS_LIMITED","ACTUAL_PAYMENT_GU_LOSS_NOT_LIMITED","NOT_APPLICABLE"]},"uri":{"type":"string","readOnly":true},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"errors":{"type":"array","readOnly":true,"items":{"type":"string"}}}},"TreatiesBulkEdit":{"required":["attachmentLevel","cedant","treatyNumber","treatyType"],"type":"object","properties":{"treatyId":{"type":"integer","format":"int32","description":"ID of treaty."},"treatyNumber":{"maxLength":20,"minLength":0,"type":"string"},"treatyName":{"maxLength":40,"minLength":0,"type":"string"},"cedant":{"$ref":"#/components/schemas/CedantInfo"},"producer":{"$ref":"#/components/schemas/ProducerInfo"},"treatyType":{"type":"string","description":"Type of treaty.","enum":["CATA","CORP","NCAT","QUOT","STOP","SURP","WORK"]},"currency":{"description":"Currency of policy.","type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of currency."},"code":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency this program treaty’s terms. For example, _USD_."},"name":{"type":"string","description":"Name of currency."}}},"attachmentBasis":{"type":"string","description":"Defines how insurance policies have their losses covered. If `L` (losses occurring), claims are covered that occur during the period of this treaty. If `R` (risks attaching), claims are covered if policy inception occurs during period of this treaty.\n","example":"R","enum":["L","R"]},"attachmentLevel":{"type":"string","description":"Level at which treaty is attached. One of `ACCT` (account), `LOC` (location), `POL` (policy), `PORT` (portfolio)\n","example":"PORT","enum":["PORT","ACCT","POL","LOC"]},"premium":{"type":"number","format":"double","description":"Amount an insurer or reinsurer charges to provide the coverage described in the policy or treaty\n","example":20000},"occurrenceLimit":{"type":"number","format":"double","description":"Maximum amount that paid out for an event.\n","example":1000000},"attachmentPoint":{"type":"number","format":"double","description":"Amount at which the occurrence layer begins to take loss.","example":220000},"riskLimit":{"type":"number","format":"double","description":"Maximum amount paid out for risk in an event. Applies to `QUOT` and `SURP` treaties\n","example":200000},"retentionAmount":{"format":"double","description":"Amount of risk or loss kept by the ceding company for its own account or for others\n","type":"number","example":150},"percentagePlaced":{"type":"number","description":"Percentage of a treaty’s coverage that has been accepted by participating reinsurers","format":"double"},"effectiveDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z","description":"Effective date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date losses are eligible for recovery.\n"},"expirationDate":{"type":"string","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z","description":"Expiration date of this treaty in  format, e.g. _2020-01-01T00:00:00.000Z_. From this date a loss-occurring policy/treaty/program no longer takes loss and a risks-attaching policy/treaty/program no longer allows risks to attach.\n"},"percentageRetention":{"type":"number","format":"double","description":"Percentage of the reinsurer’s share of treaty losses not covered by retrocessions. Determines the losses for the `RN` financial perspective and the net premium a reinsurer receives for a treaty.\n","example":0},"percentageRiShare":{"type":"number","format":"double","description":"Percentage of treaty coverage assigned to reinsurer. Used in calculation of `RG` perspective losses\n","example":90},"percentageCovered":{"type":"number","format":"double","description":"Percentage of loss greater than the attachment point covered by a treaty. Not applicable to `SURP` treaties.\n","example":50},"priority":{"type":"integer","format":"int32","description":"Inurning priority of this treaty. Lower numbers take losses prior to higher numbers\n","example":3},"numberOfReinstatements":{"type":"integer","format":"int32","description":"Number of reinstatements. Restoration of the treaty occurrence limit to its full amount after an event that led to a non-zero reinsurance payout so that the reinsured has the full limit coverage for the next event occurrence\n\nUsed in calculating catastrophe and corporate catastrophe treaty statistics, including average annual loss. The event loss table and the EP curves assume unlimited reinstatements\n","example":99},"reinstatementCharge":{"type":"number","format":"double","example":0,"description":"Amount of premium the insured must pay the insurer to reinstate the coverage of the treaty after it is exhausted. Applies to `CATA` treaties only\n"},"maolAmount":{"type":"number","format":"double","description":"Maximum Any One Life Amount","example":150},"isValid":{"type":"boolean","description":"Not used. Retained for legacy purposes.\n\nTo avoid potential issues, do not set as `false` unless instructed by Moody's RMS."},"userId1":{"type":"string"},"userId2":{"type":"string"},"aggregateDeductible":{"type":"number","format":"double"},"aggregateLimit":{"type":"number","format":"double"},"uri":{"type":"string","readOnly":true},"lobs":{"type":"array","description":"List of lines of business.","items":{"$ref":"#/components/schemas/LineOfBusinessInfo"}},"lossOccurrences":{"type":"array","description":"List of lost occurrences. A treaty loss occurrence is an an event, a portion of an event, or a collection of events to which reinsurance terms are applied to determine the split of liability.","items":{"$ref":"#/components/schemas/LossOccurrenceBulkEdit"}},"operationType":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"label":{"type":"string"},"errors":{"type":"array","readOnly":true,"items":{"type":"string"}},"tagIds":{"type":"array","description":"List of tags to apply to account. See [Tags](ref:reference-data-api-overview).","items":{"type":"integer","format":"int32"}}}}},"securitySchemes":{"rms_bearer_token":{"type":"http","description":"RMS tenant specific bearer token to make authorized requests with temporary life span","scheme":"bearer","bearerFormat":"JWT"},"rms_api_key":{"type":"apiKey","name":"Authorization","description":"RMS tenant specific api key to make authorized requests","in":"header"}}}}