openapi: 3.2.0 info: title: Risk Modeler Account V2 API description: This documentation provides information on the Risk Modeler 2.0 public API. version: March, 2023 servers: - url: https://{host}/riskmodeler description: Risk Intelligence Analytics Platform 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_Auth: [] tags: - name: AccountV2 paths: /v2/accounts: get: operationId: searchAccountsv2 summary: Get accounts description: '' parameters: - name: datasource in: query description: Name of the EDM. schema: type: string - name: q in: query description: 'Filters query results by evaluating the value of expressions. Supports four types of operators: * Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100` * Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name="xyz"` , `id=100 OR type="abc"` * List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN ("abc","xyz")` * Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE "abc "` , `type NOT LIKE " xyz* "` To learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data).' schema: type: string - name: sort in: query description: Specify `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 to display on the page. schema: type: integer format: int32 - name: offset in: query description: 'Number of pages offset before the first page of returned records. By default, _0_. ' schema: type: integer format: int32 - name: portfoliofilter in: query description: If This search was triggered from portfolio starting at _0_. schema: type: boolean - name: policyExpirationDays in: query schema: type: integer format: int32 default: 120 responses: '200': description: List of accounts successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/AccountSearchResult' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 post: operationId: createAccountv2 summary: Create account description: '' parameters: - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '201': description: Account created. headers: Location: description: Account resource style: simple schema: type: string format: URI '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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/count: get: operationId: getExposureCountAccountv2 summary: Count accounts description: '' parameters: - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Account count successfully retrieved. content: application/json: schema: type: integer format: int64 '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}: get: operationId: getAccountv2 summary: Get account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Account information successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/Account' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 put: operationId: updateAccountv2 summary: Update account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Account' required: true responses: '204': description: Validation 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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 delete: operationId: deleteAccountv2 summary: Delete account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '202': description: 'Accepted: A `DELETE_ACCOUNT` job was added to the workflow engine queue for processing. Returns a URL in the `Location` header that enables you to track the status of the job e.g. `/{host}/v1/workflows/100000`. Send periodic HTTP GET requests to the URL for the job status. See [Workflow Engine](https://developer.rms.com/rms-developers/docs/workflow-engine). ' headers: Location: description: workflowId style: simple schema: type: string format: URI '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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/analyses: get: operationId: getAccountAnalysesResultsV2 summary: Get results by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string - name: q in: query description: 'Filters query results by evaluating the value of expressions. Supports four types of operators: * Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100` * Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name="xyz"` , `id=100 OR type="abc"` * List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN ("abc","xyz")` * Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE "abc "` , `type NOT LIKE " xyz* "` To learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data).' schema: type: string - name: sort in: query description: Specify `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 displayed per page. schema: type: integer format: int32 - name: offset in: query description: 'Number of pages offset before the first page of returned records. By default, _0_. ' schema: type: integer format: int32 - name: userName in: query description: Name of <> that ran the analysis. schema: type: string - name: runDate in: query description: Date that the analysis was run. schema: type: string responses: '200': description: Analyses for exposure successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/AnalysisSearchResultV2' '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 "View Results" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/convertcurrency: post: operationId: convertAccountCurrencyv2 summary: Convert currency by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/Currency' required: true responses: '202': description: 'Accepted: A job with the specified ID has been added to the workflow engine queue for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).' headers: Location: description: workflowId style: simple schema: type: string format: URI '400': description: Bad Request. The input data is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' '403': description: 'Forbidden: Access to this resource is denied or not authorized to perform the "Edit Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/copy: post: operationId: copyAccountsv2 summary: Copy account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyAccountInfo' required: true responses: '202': description: 'Accepted: A job with the specified ID has been added to the workflow engine queue for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).' headers: Location: description: workflowId style: simple schema: type: string format: URI '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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/coordinate: get: operationId: getCoordinateByLatitudeAndLongitudeAccountv2 summary: Get account locations description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string - name: latitude in: query description: Latitude coordinates. schema: type: number format: double - name: longitude in: query description: Longitude coordinates. schema: type: number format: double responses: '200': description: Location coordinate retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/Coordinate' '403': description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/coordinates: get: operationId: getCoordinatesByAccountv2 summary: Get location coordinates by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: List of location coordinates retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/Coordinate' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/countries: get: operationId: getCountriesByAccountv2 summary: Get countries by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: List of countries retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/CountryMetrics' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/locationcount: get: operationId: getLocationCountv2 summary: Count locations by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Number of locations is successfully retrieved. content: application/json: schema: type: integer format: int64 '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' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/geohaz: post: operationId: geohazAccountv2 summary: Geohazard account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: description: Layers that define geocoding or hazard lookup jobs. content: application/json: schema: type: array items: $ref: '#/components/schemas/LayerInfo' required: true responses: '202': description: 'Accepted: A job with the specified ID has been added to the workflow engine queue for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).' headers: Location: description: url containing identifier of the submitted workflow. style: simple schema: type: string format: URI '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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/metrics: get: operationId: getAccountMetricsv2 summary: Get metrics by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Metrics for a specified account are successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/AccountMetrics' '400': description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Accounts" action.' 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' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/move: post: operationId: moveAccountv2 summary: Move account to EDM description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: option in: query description: Include (`1`) or exclude (`0`) locations in moved account. schema: type: integer format: int32 maximum: 1 minimum: 0 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '201': description: Account successfully moved. headers: Location: description: URI for newly created account style: simple schema: type: string format: URI '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 Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/policycount: get: operationId: getPolicyCountv2 summary: Count policies by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Number of policies is successfully retrieved. content: application/json: schema: type: integer format: int64 '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' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/process: post: operationId: processAccountv2 summary: Analyze account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProcessInputV2' required: true responses: '202': description: 'Accepted: A job with the specified ID has been added to the workflow engine queue for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).' headers: Location: description: url containing identifier of the submitted workflow. style: simple schema: type: string format: URI '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 "Add to Analysis Builder" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/sites: get: operationId: getSiteNamesv2 summary: Get sites by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: List of site names retrieved. content: application/json: schema: type: array items: type: string '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/reports: get: tags: - AccountV2 summary: Get account reports description: '' operationId: accountReportsv2 parameters: - name: id in: path description: ID number of the account. required: true schema: minimum: 1 type: integer format: int32 - name: datasource in: query description: Name of the EDM. required: true schema: type: string - name: q in: query description: 'Filters query results by evaluating the value of expressions. Supports four types of operators: * Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100` * Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name="xyz"` , `id=100 OR type="abc"` * List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN ("abc","xyz")` * Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE "abc "` , `type NOT LIKE " xyz* "` To learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data).' schema: type: string - name: sort in: query description: Specify `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 displayed per page. schema: type: integer format: int32 - name: offset in: query description: 'Number of pages offset before the first page of returned records. By default, _0_. ' schema: type: integer format: int32 responses: '200': description: List of reports successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/ReportListSearchResult' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] /v2/accounts/{id}/summary_report: post: operationId: summaryReportAccountv2 summary: Generate summary report by account description: '' parameters: - name: datasource in: query description: Name of the EDM. required: true schema: type: string - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExposureSummaryReportInput' required: true responses: '202': description: Job accepted. headers: Location: description: url containing identifier of the submitted workflow. style: simple schema: type: string format: URI '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 "Download Report" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/surplustreatieslocation: get: operationId: getLocationSurplusTreatiesv2 summary: Get surplus treaties by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Location level surplus treaties retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/Treaty' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/validate: get: operationId: validateAccountv2 summary: Validate account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Validation retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationConditionValidationInfo' '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 "View Accounts" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 /v2/accounts/{id}/validatemedia: get: operationId: downloadValidationAccountFilev2 summary: Get validation file by account description: '' parameters: - name: id in: path description: ID number of the account. required: true schema: type: integer format: int32 minimum: 1 - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Validation retrieved. content: '*/*': schema: type: object application/json: schema: type: object '400': description: 'Bad Request: Please check that you are provided all required values.' content: '*/*': schema: $ref: '#/components/schemas/ErrorMessage' application/json: schema: $ref: '#/components/schemas/ErrorMessage' '403': description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Accounts" action.' content: '*/*': schema: $ref: '#/components/schemas/ErrorMessage' application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - AccountV2 components: schemas: AnalysesItemV2: type: object properties: id: type: integer format: int32 name: type: string runDate: type: string description: type: string rdmName: type: string regroup: type: integer format: int32 exposureType: type: integer format: int32 engineVersion: type: string groupType: type: string cedant: type: string lob: type: string exposureId: type: integer format: int32 dataSource: type: string riGuid: type: string jobId: type: integer format: int64 jobUUID: type: string isGroup: type: boolean modelProfile: $ref: '#/components/schemas/ExposureValue' outputProfile: $ref: '#/components/schemas/ExposureValue' engine: $ref: '#/components/schemas/ExposureValue' status: $ref: '#/components/schemas/ExposureValue' type: $ref: '#/components/schemas/ExposureValue' peril: $ref: '#/components/schemas/ExposureValue' subPeril: $ref: '#/components/schemas/ExposureValue' region: $ref: '#/components/schemas/ExposureValue' lossAmplification: $ref: '#/components/schemas/ExposureValue' mode: $ref: '#/components/schemas/ExposureValue' insuranceType: $ref: '#/components/schemas/ExposureValue' vulnerabilityCurve: $ref: '#/components/schemas/ExposureValue' user: $ref: '#/components/schemas/ExposureValue' eventRateSchemes: type: array items: type: string currency: $ref: '#/components/schemas/AnalysisCurrency' engineSubType: $ref: '#/components/schemas/ExposureValue' framework: type: string simulationSetId: type: integer format: int64 simulationPeriods: type: integer format: int32 exposureSetId: type: string ProcessInputV2: type: object properties: exposureType: type: string enum: - PORTFOLIO - ACCOUNT - LOCATION - POLICY - STEP_POLICY - TREATY - AGGPORTFOLIO edm: type: string currency: $ref: '#/components/schemas/Currency' modelProfileId: type: integer format: int32 eventRateSchemeId: type: integer format: int32 treaties: type: array items: type: integer format: int32 jobName: type: string maxLength: 64 minLength: 0 pattern: ^\w((?!--)[\w\s:-])*\w$|^\w*$ id: type: integer format: int32 minimum: 1 outputProfileId: type: integer format: int32 globalAnalysisSettings: $ref: '#/components/schemas/GlobalAnalysisSettings' climateChangeVariationId: type: integer format: int32 maximum: 68 minimum: 0 required: - currency - edm CopyAccountInfo: type: object properties: newNumber: type: string newName: type: string linked: type: boolean required: - newNumber GlobalAnalysisSettings: type: object properties: franchiseDeductible: type: boolean minLossThreshold: type: number format: double minimum: 0 treatConstructionOccupancyAsUnknown: type: boolean numMaxLossEvent: type: integer format: int32 maximum: 5000 minimum: 1 required: - franchiseDeductible - minLossThreshold - numMaxLossEvent - treatConstructionOccupancyAsUnknown LineOfBusiness: type: object properties: id: type: integer format: int32 name: type: string maxLength: 20 minLength: 0 required: - name LayerInfo: type: object properties: name: description: Name of a peril model that estimates losses for natural or man-made hazards, such as earthquakes, floods, hurricanes, or acts of terrorism. type: string type: description: Name of the job type. One of `geocode` or `hazard`. type: string engineType: description: Name of engine. type: string version: description: Version of the peril model. type: string layerOptions: description: 'Options that apply to the layer. For example, `aggregateTriggerEnabled`, `geoLicenseType`, `overrideUserDef`, `skipPrevGeocoded`, `skipPrevHazard`. ' type: object additionalProperties: type: string required: - engineType - name - type - version Cedant: description: A risk-holding party (insurer/reinsurer) that is transferring a portion of risk to another risk-holding party (reinsurer/retrocessionaire). type: object properties: id: type: string maxLength: 20 minLength: 0 pattern: ^\w([\w-]*\w|)$ name: type: string maxLength: 40 minLength: 0 required: - name AnalysisSearchResultV2: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/AnalysesItemV2' AccountMetrics: type: object properties: totalLocations: type: integer format: int32 totalPolicies: type: integer format: int32 totalEmployees: type: number format: double totalInsuredValue: $ref: '#/components/schemas/Amount' perilsExposed: type: string linkedAccount: $ref: '#/components/schemas/Account' linkedDatasource: type: string name: type: string number: type: string owner: type: string underwriter: type: string producer: type: string branch: type: string cedant: type: string geocodeVersion: type: string hazardVersion: type: string createDate: type: string ExposureValue: type: object properties: id: type: integer format: int32 code: type: string name: type: string LossOccurrence: type: object properties: id: type: integer format: int32 treatyId: type: integer format: int32 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' required: - treatyId ErrorMessage: type: object properties: code: type: string message: type: string logId: type: string CountryMetrics: type: object properties: country: $ref: '#/components/schemas/ExposureValue' locationCount: type: integer format: int32 Producer: description: Agent or brokerage firm that produced a policy. type: object properties: id: type: string maxLength: 20 minLength: 0 pattern: ^\w([\w-]*\w|)$ name: type: string maxLength: 40 minLength: 0 required: - name LocationConditionValidationInfo: type: object properties: message: type: string policyNumber: type: string locationNumber: type: string locationName: type: string condition1: type: string condition2: type: string AccountSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/AccountSearchItem' Treaty: description: 'A reinsurance contract between an underwriter and a primary insurer that applies to a collection of related exposures. Under the terms of the treaty, the primary insurer (for example, a cedant) transfers risk to the underwriter in exchange for a premium and the reinsurer assumes financial responsibility for that risk. ' type: object properties: treatyId: type: integer format: int32 treatyNumber: type: string maxLength: 20 minLength: 0 treatyName: type: string maxLength: 40 minLength: 0 cedant: $ref: '#/components/schemas/Cedant' producer: $ref: '#/components/schemas/Producer' treatyType: description: The treaty type. $ref: '#/components/schemas/ExposureValue' currency: description: Indicates treaty currency. All monetary fields for a single treaty are considered to be in the same currency. However, treaties can be in a different currency than the exposures to which they are being attached. During analysis, Risk Modeler converts all currencies to the analysis currency.. $ref: '#/components/schemas/ExposureValue' attachBasis: $ref: '#/components/schemas/ExposureValue' attachLevel: $ref: '#/components/schemas/ExposureValue' premium: type: number format: double occurLimit: description: Maximum amount that a treaty pays out for all locations for any event. type: number format: double attachPt: description: Value at which the treaty takes effect. type: number format: double riskLimit: type: number format: double retentAmt: type: number format: double pcntPlaced: type: number format: double effectDate: type: string expireDate: type: string pcntRetent: description: Percentage of the reinsurer's share of the treaty losses that are not covered by retrocessions. Determines the losses for the reinsurance net loss financial perspective and the net premium that a reinsurer receives for a treaty. Calculated as reinsurance gross loss multiplied by the percentage retention by treaty. type: number format: double pcntRiShare: type: number format: double pcntCovered: description: Percentage of loss greater than the attachment point covered by a treaty. Not applicable to Surplus Share treaties. type: number format: double priority: type: integer format: int32 numOfReinst: type: integer format: int32 reinstCharge: type: number format: double maolAmount: type: number format: double isValid: type: boolean userId1: type: string userId2: type: string lobs: type: array items: $ref: '#/components/schemas/LineOfBusiness' aggregateDeductible: type: number format: double aggregateLimit: type: number format: double lossOccurrences: type: array items: $ref: '#/components/schemas/LossOccurrence' required: - attachLevel - cedant - treatyNumber - treatyType Branch: description: Branch that underwrites the account. type: object properties: id: type: integer format: int32 name: type: string maxLength: 30 minLength: 0 required: - name AccountSearchItem: type: object properties: accountId: type: integer format: int32 accountNumber: type: string accountName: type: string cedantName: type: string producerName: type: string underwriterName: type: string branchName: type: string numLocations: type: integer format: int32 userId1: type: string userId2: type: string userId3: type: string userId4: type: string userText1: type: string userText2: type: string geocodeVersion: type: string hazardVersion: type: string ownerName: type: string updatedBy: type: string stampDate: type: string jobStatus: type: string jobStartDate: type: string jobEndDate: type: string resultsCount: type: integer format: int32 policyExpirationDate: type: string policyExpirationStatus: type: string totalTIV: type: number format: float reportsCount: type: integer format: int32 example: 0 Amount: type: object properties: value: type: number format: double currencyCode: type: string UnderWriter: description: "Risk-holding party that transfers risk to a cedant in exchange for some premium. \n" type: object properties: id: type: integer format: int32 name: type: string maxLength: 30 minLength: 0 required: - name Currency: type: object properties: code: type: string scheme: type: string asOfDate: type: string vintage: type: string required: - asOfDate - code - scheme - vintage Band: type: object properties: greaterThanOrEqualTo: type: number format: double minimum: 0 lessThan: type: number format: double maximum: 10000 required: - greaterThanOrEqualTo ReportListSearchItem: type: object properties: id: type: integer format: int64 name: type: string edmName: type: string createDate: type: string exposureId: type: integer format: int32 exposureType: type: string enum: - PORTFOLIO - ACCOUNT - LOCATION - POLICY - STEP_POLICY - TREATY - AGGPORTFOLIO userName: type: string notes: type: string AnalysisCurrency: type: object properties: name: type: string code: type: string scheme: type: string asOfDate: type: string vintage: type: string required: - asOfDate - code - scheme - vintage Account: type: object properties: id: description: ID number of the account. type: integer format: int32 name: description: Name of the account. type: string number: description: Number of the account. type: string status: type: string cedant: $ref: '#/components/schemas/Cedant' producer: $ref: '#/components/schemas/Producer' underwriter: $ref: '#/components/schemas/UnderWriter' branch: $ref: '#/components/schemas/Branch' userId1: description: User-defined attribute 1 type: string userId2: description: User-defined attribute 2 type: string userId3: description: User-defined attribute 3 type: string userId4: description: User-defined attribute 4 type: string userText1: description: User text 1 type: string userText2: description: User text 2 type: string createDate: description: Date and time that account was created. type: string stampDate: type: string state: type: string enum: - InActive - Active linkId: description: '' type: string guid: description: '' type: string isValid: description: Account valid flag. type: boolean CustomData: type: object additionalProperties: type: string required: - number ReportListSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/ReportListSearchItem' CustomBand: type: object properties: hazard: type: string bands: type: array items: $ref: '#/components/schemas/Band' maxItems: 10 minItems: 1 required: - hazard Coordinate: type: object properties: locationId: type: integer format: int32 locationNumber: type: string latitude: type: number format: double longitude: type: number format: double streetAddress: type: string geoResolutionCode: $ref: '#/components/schemas/ExposureValue' ExposureSummaryReportInput: type: object properties: perilList: type: array items: type: string maxItems: 2147483647 minItems: 1 reportName: type: string customBands: type: array items: $ref: '#/components/schemas/CustomBand' required: - perilList securitySchemes: RMS_Auth: type: apiKey name: Authorization in: header description: An API key is a token that enables a client application to make requests to tenant applications running on Intelligent Risk Platform. x-default: XXXXXXXXXX x-readme: explorer-enabled: false samples-languages: - curl - java - csharp - node - python proxy-enabled: true samples-enabled: true