openapi: 3.2.0 info: title: Risk Modeler Metrics V1 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: MetricsV1 paths: /v1/analyses: get: operationId: getAnalysesResults summary: Get results description: '' parameters: - 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: All Analyses successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/AnalysisSearchResult' '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\n perform the View Results action." content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' deprecated: true security: - RMS_Auth: [] tags: - MetricsV1 delete: operationId: deleteAnalyses summary: Delete result description: '' requestBody: content: application/json: schema: type: array items: type: integer format: int64 required: true responses: '204': description: A list of Analyses deleted. content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '400': description: 'Forbidden: Access to this resource is denied or not authorized to perform the Edit Results 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: - MetricsV1 /v1/analyses/{id}: put: operationId: runRenameAnalysis summary: Rename result description: '' parameters: - name: id in: path description: ID number of analysis result. Must be valid analysis ID. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/RenameAnalysisInput' required: true responses: '202': description: 'Accepted: A `RENAME_ANALYSIS` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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 "Rename Analysis" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 delete: operationId: deleteAnalysis summary: Delete result description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 responses: '204': description: Analysis deleted successfully content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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 Results action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/analysis-region: get: operationId: getAnalysisRegions summary: Get region details description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 responses: '200': description: List of region details for specified analysis successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/AnalysisRegionSearchResult' '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: - MetricsV1 /v1/analyses/{analysisID}/cedants: get: operationId: getCedantsByAnalysisv1 summary: Get cedants by result description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). schema: type: string responses: '200': description: List of Cedants in the analysis is successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/CedantSearchResult' '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: - MetricsV1 /v1/analyses/{id}/climate-change: post: operationId: runClimateChange summary: Calculate climate change description: '' parameters: - name: id in: path description: ID number of <> result. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClimateChangeInput' required: true responses: '202': description: 'Accepted: A `CLIMATE_CHANGE` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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: - MetricsV1 /v1/analyses/{id}/convertcurrency: post: operationId: convertResultCurrency summary: Convert result currency description: '' parameters: - name: id in: path description: ID number of <>. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: '*/*': schema: $ref: '#/components/schemas/ConvertResultCurrencyInput' required: true responses: '202': description: 'Accepted: A `CONVERT_RESTULT_CURRENCY` 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. 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\n perform the Convert Result Currency action." content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/convert-event-rate-loss: post: operationId: convertAnalysisEvent summary: Convert event rates and losses description: '' parameters: - name: id in: path description: ID number of the <>. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/ConvertEventInput' required: true responses: '202': description: 'Accepted: A `CONVERT_EVENT_LOSS_RATE` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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\n perform the Convert Event Rates action." content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/ep: get: operationId: getEPMetricsByAnalysis summary: Get EP metrics description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: treatyId in: query description: ID of treaty applied to result. schema: type: integer format: int32 - name: exposureId in: query description: ID of exposure analyzed. schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 - name: metricType in: query description: Type of metric. One of `ELT`, `EP`, or `STATS`. schema: type: string responses: '200': description: List of EP metrics for a specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/MetricsOutput' '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: - MetricsV1 /v1/analyses/{id}/ep/interpolate: get: operationId: getEPInterpolateMetricResults summary: Get EP interpolation results description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: treatyId in: query description: ID of treaty applied to result. schema: type: integer format: int32 - name: exposureId in: query description: ID of exposure analyzed. schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 - name: key in: query description: Metric Key name required: true schema: type: string - name: value in: query description: Metric Key value schema: type: number format: double - name: metricType in: query description: Type of metric. One of `ELT`, `EP`, or `STATS`. schema: type: string responses: '200': description: List of Interpolation EP results successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/MetricsOutput' '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: - MetricsV1 /v1/analyses/{id}/elt: get: operationId: getEventLossTableResults summary: Get ELT description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: limit in: query description: Number of records displayed per page, maximum is _100000_. Default is _100_. schema: maximum: 100000 minimum: 1 type: integer format: int32 default: 100 - name: treatyId in: query description: Treaty ID 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: exposureId in: query description: Exposure ID schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 - name: eventIds in: query description: IDs of events analyzed. schema: type: array items: type: integer format: int32 maxItems: 25 minItems: 0 uniqueItems: true responses: '200': description: Report for specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/EventLossItem' '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: - MetricsV1 /v1/analyses/{analysisID}/metrics: get: operationId: getMetrics summary: Get metrics description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: metricType in: query description: Type of metrics. One of `ELT`, `EP`, `STATS`. required: true schema: type: string enum: - STATS - ELT - EP - name: position in: query description: Array of <>s. required: true schema: type: array items: type: string - name: granularity in: query description: granularity. schema: type: array items: type: string default: policy enum: - POLICY - name: epType in: query description: ep Type. schema: type: array items: type: string enum: - OEP - AEP - TCE_AEP - TCE_OEP - name: returnPeriod in: query description: returnPeriod. schema: type: array items: type: integer format: int32 maxItems: 12 minItems: 0 - name: filterCondition in: query description: Filter condition. 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 displayed per page. schema: type: integer format: int32 default: 100 maximum: 1000 - name: offset in: query description: Number of pages offset before the first page of returned records. By default, _0_. schema: type: integer format: int32 default: 0 responses: '200': description: metrics for specified analysis successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/MetricsResult' '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: - MetricsV1 /v1/analyses/{id}/keylosses: get: operationId: getNonEpKeyLoss summary: Get key losses description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: treatyId in: query description: Treaty ID schema: type: integer format: int32 - name: exposureId in: query description: Exposure ID schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 responses: '200': description: Key Losses for specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/KeyLossItem' '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: - MetricsV1 /v1/analyses/{analysisID}/location-aal: get: operationId: getAALMetrics summary: Get location AAL description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true 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 default: AAL DESC - name: limit in: query description: Number of records displayed per page. schema: type: integer format: int32 default: 100 maximum: 1000 - name: offset in: query description: 'Number of pages offset before the first page of returned records. By default, _0_. ' schema: type: integer format: int32 default: 0 responses: '200': description: Location AAL for specified analysis successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/LocationAALResult' '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: - MetricsV1 /v1/analyses/{id}/map-perspective: post: operationId: mapPerspective summary: Convert financial perspectives description: '' parameters: - name: id in: path description: ID of the <>. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/MapPerspectiveInput' required: true responses: '202': description: 'Accepted: A `MAP_PERSPECTIVE` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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 "Financial Re-Mapping" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/marginal-impact: post: operationId: marginalImpactv1 summary: Calculate marginal impact report description: '' parameters: - name: id in: path description: ID number of a portfolio-level <>. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/MarginalImpactInput' required: true responses: '202': description: 'Accepted: A `MARGINAL_IMPACT` 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 content: application/json: schema: type: object properties: lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object length: type: integer format: int32 location: type: string format: uri language: type: object properties: displayName: type: string language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean status: type: integer format: int32 metadata: type: object additionalProperties: type: array items: type: object entity: type: object stringHeaders: type: object additionalProperties: type: array items: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true entityTag: type: object properties: value: type: string weak: type: boolean statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string links: type: array items: type: object properties: uriBuilder: type: object rels: type: array items: type: string rel: type: string type: type: string uri: type: string format: uri params: type: object additionalProperties: type: string title: type: string uniqueItems: true '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 "Marginal Impact" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/pate: post: operationId: processPate summary: Recalculate result with PATE description: '' parameters: - name: id in: path description: ID number of a <>. required: true schema: type: integer format: int32 minimum: 1 - name: groupInfoOnly in: query description: Group info only schema: type: boolean default: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PateInput' responses: '202': description: 'Accepted: A `PATE` 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: 'Forbidden: Access to this resource is denied or not authorized to perform the "Post Analysis Treaty Execution" 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: - MetricsV1 /v1/analyses/{analysisID}/perspectives: get: operationId: getPerspectivesForAnalysis summary: Get financial perspectives description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 responses: '200': description: Values of all available perspectives for a given analysis content: application/json: schema: $ref: '#/components/schemas/EntityResult' '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: - MetricsV1 /v1/analyses/{id}/plt: get: operationId: getPeriodLossTableResults summary: Get PLT description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: limit in: query description: Number of records displayed per page, maximum is _100000_. Default is _100_. schema: maximum: 100000 minimum: 1 type: integer format: int32 default: 100 - 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: treatyId in: query description: Treaty ID schema: type: integer format: int32 - name: exposureId in: query description: Exposure ID schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 responses: '200': description: PLT report for specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/EventLossItem' '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: - MetricsV1 /v1/analyses/{id}/rerun-ep: post: operationId: reRunEp summary: Recalculate result EP and statistics description: '' parameters: - name: id in: path description: ID number the <>. required: true schema: type: integer format: int32 minimum: 1 responses: '202': description: 'Accepted: A `RERUN_EP` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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 "Rerun Ep" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/sampledlosses: get: operationId: getSampledLoss summary: Get sampled losses description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: limit in: query description: Number of records displayed per page. schema: type: integer format: int32 - name: treatyId in: query description: Treaty ID schema: type: integer format: int32 - name: exposureId in: query description: Exposure ID schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 - name: events in: query description: EventIds list required: true schema: type: string responses: '200': description: Sampled Losses for specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/SampledLossItem' '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: - MetricsV1 /v1/analyses/{id}/simulate-losses: post: operationId: runELTToPLTConversion summary: Simulate PLT analysis description: '' parameters: - name: id in: path description: ID of the <>. required: true schema: type: integer format: int32 minimum: 1 requestBody: content: application/json: schema: $ref: '#/components/schemas/SimulateELTToPLTInput' required: true responses: '202': description: 'Accepted: A `SIMULATE_LOSSES` 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 content: application/json: schema: type: object properties: metadata: type: object additionalProperties: type: array items: type: object status: type: integer format: int32 length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string script: type: string country: type: string variant: type: string extensionKeys: type: array items: type: string uniqueItems: true unicodeLocaleAttributes: type: array items: type: string uniqueItems: true unicodeLocaleKeys: type: array items: type: string uniqueItems: true iso3Language: type: string iso3Country: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string displayName: type: string statusInfo: type: object properties: family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER statusCode: type: integer format: int32 reasonPhrase: type: string mediaType: type: object properties: type: type: string subtype: type: string parameters: additionalProperties: type: string type: object wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: type: array items: type: string uniqueItems: true cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string lastModified: type: string format: date-time date: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object entity: type: object links: type: array items: type: object properties: type: type: string params: type: object additionalProperties: type: string uri: type: string format: uri title: type: string uriBuilder: type: object rel: type: string rels: type: array items: type: string uniqueItems: true '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 "ELT to PLT Simulation" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 /v1/analyses/{id}/stats: get: operationId: getStatisticsResults summary: Get statistics description: '' parameters: - name: id in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - name: perspective in: query description: Financial perspective that provides a view of risk. One of `FA` (facultative reinsurance loss), `GR` (gross loss), `GU` (ground up loss), `QS` (quota share loss), `RG` (reinsurance gross loss), `RL` (net loss cat), `RN` (reinsurance net loss), `SS` (surplus share loss), or `WX` (working excess loss). required: true schema: type: string - name: treatyId in: query description: Treaty ID schema: type: integer format: int32 - name: exposureId in: query description: Exposure ID schema: type: integer format: int32 minimum: 0 - name: exposureType in: query description: 'Exposure identified by four-digit code, e.g. `8017` (portfolio), `8019` (account), `8020` (location). ' schema: type: integer format: int32 minimum: 1 responses: '200': description: List of Statistics for specified analysis successfully retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/StatisticsItem' '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: - MetricsV1 /v1/analyses/{analysisID}/treaties: get: operationId: getTreatiesList summary: Get treaties by result description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 minimum: 1 - 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 treaties in the Analysis is successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/TreatySearchResult' '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: - MetricsV1 /v1/analyses/{analysisID}/treaty/{treatyID}: get: operationId: getTreatyById summary: Get treaty by result description: '' parameters: - name: analysisID in: path description: ID number of result. required: true schema: type: integer format: int32 - name: treatyID in: path description: Treaty ID required: true schema: type: integer format: int32 responses: '200': description: Treaty for a specified analysis is successfully retrieved. content: application/json: schema: $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 Results" action.' content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' security: - RMS_Auth: [] tags: - MetricsV1 components: schemas: ClimateChangeInput: type: object properties: 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` ' type: string example: Combined All Parameters referenceRateSchemeId: description: 'ID of <> scheme conditioned for climate change. One of `190`, `202`, `84`, `9`. * `190`: RMS 2019 Historical Event Rates * `202`: RMS 2021 Historical Event Rates * `84`: RMS 2015 Historical Event Rates * `9`: RMS v2.0 Default Rates ' type: integer format: int32 example: 190 rcpScenario: description: 'RCP scenario. One of `2.6`, `4.5`, `6.0`, or `8.5`. * `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. * `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. * `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. * `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. ' type: number format: double example: 2.6 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` ' 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`. ' type: boolean Bucket: type: object KeyLossItem: type: object properties: eventid: type: integer format: int32 stddev: type: number format: double meanloss: type: number format: double cv: type: number format: double EntityItem: type: object properties: domainName: type: string tableSpace: type: string tableName: type: string dataOwnedBy: type: string values: type: array items: type: object additionalProperties: type: object isActive: type: boolean AnalysesItem: type: object properties: id: type: integer format: int32 name: type: string runDate: type: string description: type: string currency: type: string type: type: integer format: int32 exposureType: type: integer format: int32 peril: type: string status: type: integer format: int32 region: type: string engineVersion: type: string groupType: type: string cedant: type: string lob: type: string engineType: type: integer format: int32 subperil: type: integer format: int32 exposureId: type: integer format: int32 dataSource: type: string jobId: type: integer format: int64 jobUUID: type: string isGroup: type: boolean engineName: type: string statusName: type: string typeName: type: string subperilName: type: string rdmName: type: string regroup: type: integer format: int32 currencyName: type: string perilName: type: string regionName: type: string lossAmplification: type: integer format: int32 lossAmplificationName: type: string mode: type: integer format: int32 modeName: type: string insuranceType: type: integer format: int32 insuranceTypeName: type: string vulnerabilityCurve: type: integer format: int32 vulnerabilityCurveName: type: string riGuid: type: string PateInput: type: object properties: insert: type: array description: An array of PATE treaty adjustments to add. items: $ref: '#/components/schemas/Pate' update: type: array description: An array of PATE treaty adjustments to update. items: $ref: '#/components/schemas/Pate' delete: description: An array of PATE treaty adjustments to delete. items: $ref: '#/components/schemas/Pate' type: array Value: type: object properties: returnPeriods: type: array items: type: number format: double example: - 1.0 - 2.0 - 3.0 positionValues: type: array items: type: number format: double example: - 1.4336826286215238 - 1.4336826286215238 - 1.4336826286215238 LineOfBusiness: type: object properties: id: type: integer format: int32 name: type: string maxLength: 20 minLength: 0 required: - name AnalysisRegionSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/RegionItem' LocationAAL: type: object properties: locationId: type: integer format: int32 locationName: type: string locationNumber: type: string aal: type: number format: double standardDeviation: type: number format: double coefficientOfVariation: type: number format: double ConvertResultCurrencyInput: type: object properties: currency: $ref: '#/components/schemas/Currency' EventLossItem: type: object properties: anlsid: type: integer format: int32 example: 83343 id: type: integer format: int32 example: 8 sourceid: type: integer format: int32 example: 22267 eventid: type: integer format: int32 example: 2865697 perspvalue: type: number format: double example: 3473657.880534969 perspcode: type: string example: GU stddevi: type: number format: double example: 1066771.2741421806 stddevc: type: number format: double example: 400576.7724183246 expvalue: type: number format: double example: 4343900.0 rate: type: number format: double example: 1.2056769946866552e-06 status: type: integer format: int32 example: 0 peril: type: string example: Windstorm region: type: string example: North America oepWUC: type: number format: double example: 1.205676267823641e-06 exposureNumber: type: string EntityResult: type: object properties: entitiesTotalMatch: type: integer format: int64 entityItems: $ref: '#/components/schemas/EntityItem' 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 MetricMetadata: type: object properties: eventWeightId: type: integer format: int32 parameters: items: type: string type: array CedantSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/Cedant' TreatySearchResult: type: object properties: totalMatchCount: type: integer format: int64 searchMatchingTreatyList: type: array items: $ref: '#/components/schemas/Treaty' 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 ModelSettings: type: object properties: modelProfileId: type: integer format: int32 currency: $ref: '#/components/schemas/Currency' minLossThreshold: type: number format: float numPeriods: type: integer format: int32 RegionItem: type: object properties: region: type: string subRegion: type: string peril: type: string rateschemeid: 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 RenameAnalysisInput: type: object properties: newAnalysisName: type: string description: Name may consist of `0`-`9`, `A`-`Z`, `a`-`z`, and `_` (underscores), `-` (hyphens), `:` (colons), and blank spaces. Maximum length is 64 characters. EventRateScheme: type: object properties: modelRegionCode: type: string maxLength: 4 minLength: 4 perilCode: type: string maxLength: 2 minLength: 2 modelVersion: type: string eventRateSchemeName: type: string eventRateSchemeId: type: integer format: int32 isDefault: type: boolean isActive: type: boolean ConvertEventInput: type: object properties: analysisName: description: 'The name for the analysis with converted rates and/or losses. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and '''' '''' (blank space). String cannot start or end with a hyphen (`-`), colon (`:`), or blank space and cannot include multiple consecutive hyphens (`--`). ' type: string example: NewAnalysisName maxLength: 64 minLength: 0 pattern: ^\w((?!--)[\w\s:-])*\w$|^\w*$ eventRateSchemeIds: description: 'Array of <>s identified by ID number. ' type: array items: type: integer format: int32 eventLossAdjustmentSchemeIds: description: 'Array of <>s identified by ID number. ' type: array items: type: integer format: int32 LocationAALResult: type: object properties: totalCount: type: integer format: int32 offset: type: integer format: int32 limit: type: integer format: int32 locationAALs: type: array items: $ref: '#/components/schemas/LocationAAL' 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 MetricsResult: type: object properties: searchTotalMatch: type: integer format: int32 metricType: type: string enum: - STATS - ELT - EP granularities: type: array items: type: string enum: - POLICY metrics: type: array items: type: object MarginalImpactInput: type: object properties: marginalImpactAnalysisIds: description: ID of an account-level analysis result. Only one ID is supported in current release. type: array items: type: integer format: int32 maxItems: 1 minItems: 1 currency: $ref: '#/components/schemas/Currency' outputType: description: Granularity of the report. If `Account`, the report returns projected losses for all policies and locations grouped by peril. If `Policy` the report returns projected losses for all analyses grouped by policy. type: string enum: - POLICY - ACCOUNT jobName: description: Unique name for the job. type: string maxLength: 64 minLength: 1 pattern: ^\w((?!--)[\w\s:-])*\w$|^\w*$ rateSchemes: description: Array of event rate scheme IDs to be used in metric calculations. If specified, overrides the event rate schemes used in the original analysis results. type: array items: $ref: '#/components/schemas/EventRateScheme' required: - currency - jobName - outputType SimulateELTToPLTInput: type: object properties: regionCode: type: string perilCode: type: string engineVersion: type: string eventRateSchemeId: description: 'ID of the <> 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. ' type: integer format: int32 simulationSetId: description: 'ID of a period event quantile table (PEQT). ' type: integer format: int32 simulationSetName: description: 'Name of a period event quantile table (PEQT). ' type: string simulationPeriods: description: 'Number of <>s used to generate the PLT. ' type: integer format: int64 required: - simulationPeriods - simulationSetId Currency: type: object properties: code: type: string scheme: type: string asOfDate: type: string vintage: type: string required: - asOfDate - code - scheme - vintage MetricsOutput: type: object properties: id: type: integer format: int32 example: 8 workflowId: type: integer format: int64 example: 9064540 structure: type: string position: type: string example: GU portfolioId: type: integer format: int32 example: 8 variationId: type: integer format: int32 example: 0 dimensions: type: array items: type: string metricName: type: string example: AEP metricMetadata: $ref: '#/components/schemas/MetricMetadata' modelSettings: $ref: '#/components/schemas/ModelSettings' metricValue: type: array items: $ref: '#/components/schemas/MetricValue' exposureNumber: type: string MetricValue: type: object properties: id: type: integer format: int32 example: 0 value: $ref: '#/components/schemas/Value' bucket: $ref: '#/components/schemas/Bucket' SampledLossItem: type: object properties: cedant: type: string lob: type: string losstype: type: string sampleid: type: integer format: int32 eventid: type: integer format: int32 loss: type: number format: double AnalysisSearchResult: type: object properties: searchTotalMatch: type: integer format: int64 searchItems: type: array items: $ref: '#/components/schemas/AnalysesItem' StatisticsItem: type: object properties: anlsid: type: integer format: int64 id: type: integer format: int64 perspcode: type: string eptype: type: string purepremium: type: number format: double totalstddev: type: number format: double netpurepremium: type: number format: double activation: type: number format: double exhaustion: type: number format: double totlossratio: type: number format: double limit: type: number format: double premium: type: number format: double netstddev: type: number format: double exhaustallreinstatements: type: number format: double exposurenumber: type: string MapPerspectiveInput: type: object properties: analysisName: description: 'The name for the analysis with converted rates and/or losses. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and '''' '''' (blank space). String cannot start or end with a hyphen (`-`), colon (`:`), or blank space and cannot include multiple consecutive hyphens (`--`). ' type: string example: NewAnalysisName maxLength: 64 minLength: 0 pattern: ^\w((?!--)[\w\s:-])*\w$|^\w*$ sourcePerspective: description: Two character string for <> in base analysis. type: string newPerspective: description: Two character string for financial perspective in new analysis. type: string mapPerspectiveOption: description: 'Option for mapping financial perspectives. * If `INCLUDE_DOWNSTREAM`, maps `sourcePerspective` to `newPerspective` and copies mapping to all downstream perspectives except `RG` and `RN`. Downstream perspectives (except `RG` and `RN`) return same results as the specified `newPerspective`. * If `DELETE_OTHER`, maps `sourcePerspective` to `newPerspective` and deletes records for all perspectives other than `newPerspective` including `sourcePerspective`. All perspectives other than the `newPerspective` return a value of 0. * If `SELECT_OTHER`, maps the `sourcePerspective` to `newPerspective`. All other downstream and upstream perspectives are unchanged. ' type: string enum: - INCLUDE_DOWNSTREAM - DELETE_OTHER - SELECTED_ONLY required: - mapPerspectiveOption - newPerspective - sourcePerspective Pate: 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: $ref: '#/components/schemas/ExposureValue' currency: $ref: '#/components/schemas/ExposureValue' attachBasis: $ref: '#/components/schemas/ExposureValue' attachLevel: $ref: '#/components/schemas/ExposureValue' premium: type: number format: double occurLimit: type: number format: double attachPt: 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: type: number format: double pcntRiShare: type: number format: double pcntCovered: 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' analysisId: type: integer format: int32 pateId: type: integer format: int64 operationType: type: string enum: - INSERT - DELETE - UPDATE - COPY - IMPORT groupId: type: integer format: int32 required: - attachLevel - cedant - treatyNumber - treatyType 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