openapi: 3.2.0 info: title: Risk Modeler Portfolio 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: PortfolioV2 paths: /v2/portfolios: get: operationId: searchPortfoliosv2 summary: Get portfolios 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 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 portfolios retrieved. content: application/json: schema: $ref: '#/components/schemas/PortfolioSearchResult' '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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 post: operationId: createPortfoliov2 summary: Create portfolio description: '' parameters: - name: datasource in: query description: Name of the EDM. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Portfolio' required: true responses: '201': description: Portfolio created. headers: Location: description: Portfolio 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/count: get: operationId: getExposureCountPortfoliov2 summary: Count portfolios description: '' parameters: - name: datasource in: query description: Name of the EDM. required: true schema: type: string responses: '200': description: Portfolio 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}: get: operationId: getPortfoliov2 summary: Get portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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: Portfolio information retrieved. content: application/json: schema: $ref: '#/components/schemas/Portfolio' '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 Portfolios" 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' security: - RMS_Auth: [] tags: - PortfolioV2 put: operationId: updatePortfoliov2 summary: Update portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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/Portfolio' required: true responses: '204': description: Portfolio successfully 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' security: - RMS_Auth: [] tags: - PortfolioV2 delete: operationId: deletePortfoliov2 summary: Delete portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. required: true schema: type: integer format: int32 minimum: 1 - name: deleteType in: query description: 'The scope of the data deleted: `PORTFOLIO_INFO`, `PORTFOLIO_ALL_ACCOUNTS`, or `PORTFOLIO_EXCEPT_ACCOUNTS`' required: true schema: type: string enum: - PORTFOLIO_INFO - PORTFOLIO_ALL_ACCOUNTS - PORTFOLIO_EXCEPT_ACCOUNTS - name: datasource in: query description: Name of the EDM. required: true schema: type: string 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/accounts: get: operationId: searchPortfolioAccountsv2 summary: Get accounts by portfolio description: '' parameters: - name: id in: path description: ID of the portfolio. required: true schema: type: integer format: int32 minimum: 1 - 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 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 accounts 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 Portfolios" 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' security: - RMS_Auth: [] tags: - PortfolioV2 put: operationId: managePortfolioAccountsv2 summary: Manage accounts by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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/PortfolioAccountsInput' 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).' '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' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/analyses: get: operationId: getPortfolioAnalysesResultsV2 summary: Get results by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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 returned records. By default, _0_. schema: type: integer format: int32 - name: userName in: query description: Name of <> that submitted the workflow. 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: - PortfolioV2 /v2/portfolios/{id}/convertcurrency: post: operationId: convertPortfolioCurrencyv2 summary: Convert currency by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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: url containing identifier of the submitted workflow. 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/coordinate: get: operationId: getCoordinateByLatitudeAndLongitudePortfoliov2 summary: Get portfolio locations description: '' parameters: - name: id in: path description: ID number of the portfolio. 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/coordinates: get: operationId: getCoordinatesByPortfoliov2 summary: Get location coordinates by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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 coordinates 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/filteredaccounts: put: operationId: manageFilteredAccountsv2 summary: Manage filtered accounts by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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/PortfolioFilteredAccountsInput' 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).' '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' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/copy: post: operationId: copyPortfoliov2 summary: Copy portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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/CopyPortfolioInfo' 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 Portfolios" 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' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/geohaz: post: operationId: geohazPortfoliov2 summary: Geohazard portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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: 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/metrics: get: operationId: getPortfolioMetricsv2 summary: Get metrics by portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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 portfolio are successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PortfolioMetrics' '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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/portfolios/{id}/process: post: operationId: processPortfolioV2 summary: Analyze portfolio description: '' parameters: - name: id in: path description: ID number of the portfolio. 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: - PortfolioV2 /v2/portfolios/{id}/reports: get: tags: - PortfolioV2 summary: Get portfolio reports description: '' operationId: portfolioReportsv2 parameters: - name: id in: path description: ID number of the portfolio. 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 Portfolios" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] /v2/portfolios/{id}/summary_report: post: operationId: summaryReportPortfoliov2 summary: Generate summary report by portfolio 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 portfolio. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ExposureSummaryReportInput' 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 "Download Report" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 /v2/exposurebatches: post: operationId: executeBatchOperationv2 summary: Manage portfolio exposures in batch description: '' parameters: - name: operation in: query description: Operation of batch resource schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/BatchRequest' 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).' '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' '404': description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - PortfolioV2 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 BatchRequest: type: object properties: method: type: string path: type: string body: type: string 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 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 CopyPortfolioInfo: type: object properties: deep: type: boolean newName: type: string newNumber: type: string newDescription: type: string isDeep: type: boolean required: - newDescription - newName - newNumber AnalysisSearchResultV2: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/AnalysesItemV2' ExposureValue: type: object properties: id: type: integer format: int32 code: type: string name: type: string PortfolioSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/PortfolioSearchItem' ErrorMessage: type: object properties: code: type: string message: type: string logId: type: string PortfolioFilteredAccountsInput: type: object properties: selectAll: type: boolean queryFilter: type: string markedAccounts: type: array items: type: integer format: int32 manageExistingAccounts: type: boolean AccountSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/AccountSearchItem' PortfolioAccountsInput: type: object properties: accountsToAdd: type: array items: type: integer format: int32 accountsToRemove: type: array items: type: integer format: int32 PortfolioMetrics: type: object properties: totalAccounts: type: integer format: int32 totalLocations: type: integer format: int32 totalPolicies: type: integer format: int32 perilsExposed: type: string name: type: string number: type: string description: type: string owner: type: string createDate: type: string geocodeVersion: type: string hazardVersion: type: string 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 Portfolio: type: object properties: id: type: integer format: int32 name: type: string number: type: string description: type: string createDate: type: string stampDate: type: string required: - description - name - number 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 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' PortfolioSearchItem: type: object properties: id: type: integer format: int32 name: type: string number: type: string description: type: string createDate: type: string stampDate: type: string geocodeVersion: type: string hazardVersion: type: string ownerName: type: string updatedBy: type: string jobStatus: type: string jobStartDate: type: string jobEndDate: type: string required: - description - name - number 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