{"openapi":"3.0.1","info":{"title":"Legacy API Operations","description":"Legacy operations used by UI app experience flows, documented as-is","version":"2025.07.b"},"servers":[{"url":"https://{host}","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com."}}}],"security":[{"rms_api_key":[]},{"rms_bearer_auth":[]}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["curl","json","python","java","csharp","node"],"proxy-enabled":true,"samples-enabled":true},"tags":[{"name":"ALM Profiles"},{"name":"Model Profiles"},{"name":"Output Profiles"},{"name":"Batch Templates"},{"name":"Event Rate Schemes"},{"name":"Currency Schemes"},{"name":"Currency Scheme Vintages"},{"name":"Currency Exchange Rates"},{"name":"Currencies"}],"paths":{"/analysis-settings/almprofiles":{"get":{"tags":["ALM Profiles"],"summary":"Search ALM profiles","operationId":"getAlmProfiles","parameters":[{"name":"perilCode","in":"query","description":"Two-letter code that identifies natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","schema":{"type":"string","enum":["CS","EQ","FL","TR","WF","WS","WT"]}},{"name":"geoResCode","in":"query","description":"Two-letter georesolution code.","schema":{"type":"string"}},{"name":"countryCodes","in":"query","description":"Array of two-letter country codes.","schema":{"type":"array","items":{"type":"string"}}},{"name":"softwareVersionCode","in":"query","description":"Engine to use in analysis, e.g. _RL18_ or _RL18.1_","schema":{"type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]}},{"name":"rmsLob","in":"query","description":"Line of business, e.g. _COM_ and _IND_.","schema":{"type":"array","items":{"type":"string"}}},{"name":"analysisType","in":"query","description":"Analysis to perform, e.g. _Exceedance Probability_ and _Scenario_.","schema":{"type":"array","items":{"type":"string"}}},{"name":"internalId","in":"query","description":"ID of one or more RiskLink ALM profiles.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"id","in":"query","description":"ID of one or more ALM profiles.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"name","in":"query","description":"Name of one or more ALM profiles.","schema":{"type":"array","items":{"type":"string"}}},{"name":"orderBy","in":"query","description":"Sort order of returned model profiles. Options include _id_, _name_ and _createdat_. By default, _id_.","schema":{"type":"string"}},{"name":"autoAttach","in":"query","description":"If `true`, auto-attach filtering is applied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseAlmProfile"}}}},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/modelprofiles":{"get":{"tags":["Model Profiles"],"summary":"Search model profiles","operationId":"getModelProfiles","parameters":[{"name":"perilCode","in":"query","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","schema":{"type":"string","enum":["CS","EQ","FL","TR","WF","WS","WT"]}},{"name":"modelRegionCode","in":"query","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril. See [Moody's Peril Models List for Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/Reference/Peril_Models_List.htm)","schema":{"type":"string"}},{"name":"modelSourceCode","in":"query","description":"Source of the engine to be used in the analysis, e.g. _RMS_.","schema":{"type":"string"}},{"name":"softwareVersionCode","in":"query","description":"Engine to be used in the analysis, e.g. _RL18_.","schema":{"type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]}},{"name":"analysisType","in":"query","description":"Type of analysis. Examples include `Exceedance Probability` and `Scenario`.","schema":{"type":"array","items":{"type":"string","enum":["CA DOI","Exceedance Probability","Footprint File","Hazard Curve","Historical","Maximum Credible","Maximum Historical","Non-Runnable","Scenario","Simulated","User Defined"]}}},{"name":"id","in":"query","description":"ID of one or more model profiles.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"name","in":"query","description":"Name of one or more model profiles.","schema":{"type":"array","items":{"type":"string"}}},{"name":"orderBy","in":"query","description":"Sort order of model profiles. One of `id`, `name`, `createdAt`. By default, `id`.","schema":{"type":"string"}},{"name":"includeDeleted","in":"query","description":"If `true`, profiles marked as deleted will be included in the response. By default, `false`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionResponseModelProfile"}}}},"500":{"description":"ERROR: Internal Server Error"}}},"post":{"tags":["Model Profiles"],"summary":"Create model profile","operationId":"createModelProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProfileRequest"}}},"required":true},"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}}},"400":{"description":"Bad request (wrong or missing inputs)"},"500":{"description":"ERROR: Internal Server Error"}}},"delete":{"tags":["Model Profiles"],"summary":"Delete model profile","operationId":"deleteModelProfile","parameters":[{"name":"id","in":"query","description":"Array of model profile IDs to delete.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"204":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/modelprofiles/{modelProfileId}":{"get":{"tags":["Model Profiles"],"summary":"Get model profile","operationId":"getModelProfile","parameters":[{"name":"modelProfileId","in":"path","description":"ID of model profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProfile"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}},"put":{"tags":["Model Profiles"],"summary":"Update model profile","operationId":"updateModelProfile","parameters":[{"name":"modelProfileId","in":"path","description":"ID of model profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProfileEditRequest"}}},"required":true},"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsIdentifier"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles":{"get":{"tags":["Output Profiles"],"summary":"Search output profiles","operationId":"getOutputProfiles","parameters":[{"name":"name","in":"query","description":"Name of output profile to return. If undefined, returns all output profiles.","schema":{"type":"string"}},{"name":"includeDeleted","in":"query","description":"If `true`, deleted output profiles are returned. By default, `false`","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OutputSettings"}}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}},"post":{"tags":["Output Profiles"],"summary":"Create output profile","operationId":"createOutputProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutputSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsIdentifier"}}}},"500":{"description":"ERROR: Internal Server Error"}}},"delete":{"tags":["Output Profiles"],"summary":"Delete output profiles","operationId":"deleteOutputProfiles","parameters":[{"name":"id","in":"query","description":"ID of one or more output profiles to delete.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"204":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}}},"403":{"description":"Attempt to delete an RMS profile or a profile set as the default profile"},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles/{outputProfileId}":{"get":{"tags":["Output Profiles"],"summary":"Get output profile","operationId":"getOutputProfile","parameters":[{"name":"outputProfileId","in":"path","description":"ID of output profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutputSettings"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}},"put":{"deprecated":true,"tags":["Output Profiles"],"summary":"Update output profile","operationId":"updateOutputProfile","parameters":[{"name":"outputProfileId","in":"path","description":"ID of output profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutputSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsIdentifier"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}},"patch":{"tags":["Output Profiles"],"summary":"Update output profile","operationId":"patchUpdateOutputProfile","parameters":[{"name":"outputProfileId","in":"path","description":"ID of output profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of output profile."},"tagIds":{"description":"List of tags to apply to this model profile. See [Tags](ref:reference-data-api-overview)","type":"array","items":{"type":"integer","format":"int32"}}}}}},"required":true},"responses":{"200":{"description":"Request successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsIdentifier"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}},"delete":{"tags":["Output Profiles"],"summary":"Delete output profile","operationId":"deleteOutputProfile","parameters":[{"name":"outputProfileId","in":"path","description":"ID of output profile.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}}},"403":{"description":"Attempt to delete an RMS profile or a profile set as the default profile"},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles/commonmetrics":{"get":{"tags":["Output Profiles"],"summary":"Get output profile metrics","operationId":"getOutputProfilesCommonMetrics","parameters":[{"name":"id","in":"query","description":"IDs of output profiles.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutputMetricsResponse"}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles/meta":{"get":{"tags":["Output Profiles"],"summary":"Get output profile metadata","operationId":"getOutputProfilesMetadata","parameters":[{"name":"name","in":"query","description":"Name of output profile. If not specified, returns metadata for all output profiles.","schema":{"type":"string"}},{"name":"includeDeleted","in":"query","description":"If `true`, returns deleted model profiles. By default, `false`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OutputSettingsMetadata"}}}}},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles/defaultmetrics":{"get":{"tags":["Output Profiles"],"summary":"Get output profiles default metrics","operationId":"getOutputProfilesDefaultMetrics","responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OutputMetricRequest"}}}}},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/outputprofiles/setdefault/{outputProfileId}":{"put":{"tags":["Output Profiles"],"summary":"Update default output profile","operationId":"updateDefaultOutputProfile","parameters":[{"name":"outputProfileId","in":"path","description":"ID of output profile to set as the default","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Request successful","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutputSettings"}}}},"400":{"description":"ERROR: Bad Request"},"404":{"description":"ERROR: Not found"},"500":{"description":"ERROR: Internal Server Error"}}}},"/analysis-settings/batchtemplates":{"get":{"tags":["Batch Templates"],"summary":"Search batch templates","operationId":"searchBatchTemplates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BatchTemplateSummary"}}}}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Batch Templates"],"summary":"Create batch template","operationId":"createBatchTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchTemplateCreateRequest"}}},"required":true},"responses":{"201":{"description":"Success","headers":{"Location":{"description":"URL of the created batch template","schema":{"type":"string"}}}},"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"}}}},"/analysis-settings/batchtemplates/{batchTemplateId}":{"get":{"tags":["Batch Templates"],"summary":"Get batch template","operationId":"getBatchTemplate","parameters":[{"name":"batchTemplateId","in":"path","description":"ID of the batch template to retrieve","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchTemplate"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Batch Templates"],"summary":"Update batch template","operationId":"updateBatchTemplate","parameters":[{"name":"batchTemplateId","in":"path","description":"ID of the batch template to update","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchTemplateUpdateRequest"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Batch template not found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Batch Templates"],"summary":"Delete batch template","operationId":"deleteBatchTemplate","parameters":[{"name":"batchTemplateId","in":"path","description":"ID of the batch template to delete","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Batch template deleted successfully"},"404":{"description":"Batch template not found"},"500":{"description":"Internal Server Error"}}}},"/data-store/currencyExchangeRates":{"get":{"tags":["Currency Exchange Rates"],"summary":"Search currency exchange rates","operationId":"getCurrencyExchangeRates","parameters":[{"name":"currencySchemeCode","in":"query","description":"Name of currency scheme.","example":"AVC","required":true,"schema":{"type":"string"}},{"name":"asOfDate","in":"query","description":"Effective date of exchange rate, e.g. `yyyy-mm-dd`.","required":true,"example":"2017-07-21","schema":{"type":"string","format":"date"}},{"name":"isDerived","in":"query","description":"If `true`, includes derived currency code flag.","schema":{"type":"boolean","default":true}},{"name":"anchorCurrencyCode","in":"query","example":"USD","description":"Three-letter ISO 4217 code of currency used to calculate currency exchange rates.","schema":{"type":"string","default":""}},{"name":"projection","in":"query","description":"Name of projection.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Property on which returned currency schemes are sorted.","schema":{"type":"string","default":"currencyCode"}},{"name":"sortOrder","in":"query","description":"Sort order of currency schemes. One  `1` (ASC) or `-1` (DESC).","schema":{"type":"integer","format":"int32","default":1}}],"responses":{"200":{"description":"Currency Exchange Rates","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencySchemeExchangeRates"}}}},"400":{"description":"Invalid Input Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Job failed with error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Currency Exchange Rates"],"summary":"Create currency exchange rates","operationId":"postCurrencyExchangeRates","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencySchemeExchangeRatesPost"}}},"required":true},"responses":{"200":{"description":"Rates loaded for the scheme","headers":{"Warning":{"description":"Warning message: Usually includes deprecation message and / or sunset date if announced","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencySchemeExchangeRatesPost"}}}},"400":{"description":"Invalid Input Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Job failed with error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/currencyExchangeRates/file":{"get":{"tags":["Currency Exchange Rates"],"summary":"Download currency exchange rates","operationId":"getCurrencyExchangeRatesFromFile","parameters":[{"name":"currencySchemeCode","in":"query","description":"Code of currency scheme.","required":true,"schema":{"type":"string"}},{"name":"asOfDate","in":"query","description":"Effective date of exchange rate, e.g. `yyyy-mm-dd`.","required":true,"schema":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string","format":"date"}},{"name":"isDerived","in":"query","description":"If `true`, returns derived currency schemes.","schema":{"type":"boolean","default":true}},{"name":"anchorCurrencyCode","in":"query","example":"USD","description":"Code of <<glossary:anchor currency>>.","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort by columns","schema":{"type":"string","default":"currencyCode"}},{"name":"sortOrder","in":"query","description":"Sort order of exchange rates. One of `1` (ASC)  or `-1` (DESC).","schema":{"type":"integer","format":"int32","enum":[1,-1],"default":1}}],"responses":{"200":{"description":"Downloadable Stream of csv file","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Job failed with error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referencetables/currencyschemevintage":{"get":{"summary":"Search currency scheme vintages","operationId":"getCurrencySchemeVintages","tags":["Currency Scheme Vintages"],"parameters":[{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/whereParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/sortOrderParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","example":33},"totalCount":{"type":"integer","example":33},"items":{"type":"array","items":{"type":"object","properties":{"currencySchemeCode":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"CAD"},"effectiveDate":{"type":"string","description":"Effective date of currency scheme in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DDThh:mm:ss.sss`.","format":"date","example":"2022-05-03"},"vintage":{"type":"string","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`).","example":"May_2022"},"vintageDescription":{"type":"string","description":"Description of version of currency scheme.","example":"May 2022 exchange rates."},"createUserId":{"type":"string","description":"ID of <<glossary: principal>> that created the currency scheme.","example":"user.name@company.com"},"createDate":{"type":"string","format":"date-time","description":"Time that currency scheme was created.","example":"2024-07-03T07:44:17.422Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"},"updateUserId":{"type":"string","description":"ID of <<glossary: principal>> that updated the currency scheme.","example":"user.name@company.com"},"updateDate":{"type":"string","description":"Time that currency scheme was updated.","format":"date-time","example":"2024-07-03T07:44:17.422Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referencetables/eventratescheme":{"get":{"summary":"Search event rate schemes","operationId":"getEventRateSchemes","tags":["Event Rate Schemes"],"parameters":[{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/whereParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/sortOrderParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","example":126},"totalCount":{"type":"integer","example":126},"items":{"type":"array","items":{"type":"object","properties":{"eventRateSchemeId":{"type":"integer","description":"ID of event rate scheme.","example":5086},"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","enum":["CS","EQ","FL","TR","WF","WS","WT"],"example":"EQ"},"modelRegionCode":{"type":"string","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril e.g. _ACEQ_, _EUFL_. For information about models and model updates, see [Models and Data](https://support.rms.com/group/rms/peril-models) in the Moody's Support Center.","example":"NAEQ"},"modelVersionCode":{"type":"string","example":"17.0","description":"Code of model version."},"eventRateSchemeName":{"type":"string","description":"Name of event rate scheme."},"namespaceId":{"type":"integer","description":"ID of namespace.","example":2},"isDefault":{"type":"boolean","description":"If `true`, event rate scheme is default.","example":false,"default":false},"isActive":{"type":"boolean","example":true,"default":true},"externalId":{"type":"string","nullable":true},"createUserId":{"type":"string","example":"abc@company.com"},"createDate":{"type":"string","format":"date-time","example":"2024-08-29T07:32:18.609Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"},"updateUserId":{"type":"string","example":"abc@company.com"},"updateDate":{"type":"string","format":"date-time","example":"2024-08-29T07:32:18.609Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referencetables/currencyscheme":{"get":{"summary":"Search currency schemes","operationId":"getCurrencySchemes","tags":["Currency Schemes"],"parameters":[{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/whereParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/sortOrderParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Number of currency schemes returned.","example":23},"totalCount":{"type":"integer","description":"Total number of currency schemes.","example":100},"items":{"type":"array","items":{"type":"object","properties":{"currencySchemeName":{"type":"string","description":"Name of currency scheme.","example":"HVC Currency Scheme"},"currencySchemeId":{"type":"integer","example":1000000189,"description":"ID of currency scheme."},"currencySchemeCode":{"type":"string","example":"HVC","description":"Code of currency scheme."},"anchorCurrencyCode":{"type":"string","example":"USD","description":"Three-letter ISO 4217 code of currency used to calculate currency exchange rates."},"sourceName":{"type":"string","nullable":true,"example":"WSJ","description":"Name of source for exchange rates, such as a web site capturing exchange rates."},"updateIntervalInDays":{"type":"integer","nullable":true,"example":30,"description":"Frequency (in days) to update exchange rates, i.e. frequency of new currency scheme vintages. For informational purposes only."},"isDefault":{"type":"boolean","example":false,"description":"If `true`, currency scheme is default currency scheme."},"isActive":{"type":"boolean","example":true,"default":true,"description":"If `true`, currency scheme is active."},"externalId":{"type":"string","nullable":true,"example":"hvc10001","description":"External ID for currency scheme."},"createUserId":{"type":"string","description":"ID of <<glossary:principal>> that created currency scheme exchange rate.","example":"user.name@company.com"},"createDate":{"type":"string","format":"date-time","description":"Date currency scheme was crated in ISO 8601 format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2021-02-09T21:23:20.791Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"},"updateUserId":{"type":"string","example":"RMSAdmin","description":"ID of <<glossary:principal>> that updated currency scheme."},"updateDate":{"type":"string","format":"date-time","example":"2022-08-09T17:35:34.178Z","description":"Date currency scheme was updated in ISO 8601 format, e.g.  `2022-08-09T17:35:34.178Z`.","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Currency Schemes"],"summary":"Upsert currency scheme","operationId":"upsertCurrencyScheme","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["anchorCurrencyCode","currencySchemeCode","currencySchemeName","updateIntervalInDays"],"properties":{"currencySchemeId":{"description":"ID of currency scheme.\n\nIf defined, this operation updates the specified currency scheme. Otherwise, creates new currency scheme. The RMS Default currency scheme cannot be updated.","type":"integer","minimum":1},"anchorCurrencyCode":{"description":"Code of currency used to calculate value of currency. Exchange rate is rate of exchange between a currency and anchor currency. \n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`.","type":"string","example":"USD"},"currencySchemeCode":{"type":"string","description":"Code of currency scheme.\n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`."},"currencySchemeName":{"type":"string","description":"Name of currency scheme.\n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`."},"updateIntervalInDays":{"description":"Frequency (in days) to update exchange rates, i.e. frequency of new currency scheme vintages. For informational purposes only.","type":"string","format":"int32","pattern":"^(?:[0-9]|[1-9][0-9]{1,3}|[1-4][0-9]{3}|5000)$"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"inserted":{"type":"integer","description":"Number of currencies inserted.","example":5},"updated":{"type":"integer","description":"Number of currencies updated.","example":5},"failed":{"type":"integer","description":"Number of currency upserts that failed.","example":1},"duplicateRowsCount":{"type":"integer","description":"Number of duplicate rows.","example":0},"failReportPath":{"type":"string"},"reportLink":{"type":"string"},"errors":{"type":"string"},"duplicateRows":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referenceTables/currencyRatesVintage/file":{"post":{"tags":["Currency Scheme Vintages"],"summary":"Create currency scheme vintage from file","operationId":"postCurrencyRatesVintageFromFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["effectiveDate","file","vintage"],"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Flat file of `currencyCode` to `exchangeRate` mappings in CSV format.  \n\n- File must include `currencyCode` and `exchangeRate` headers.\n- File must use tilde character (`~`) as text delimiter.\n- File must be smaller than 20MB in size."},"vintage":{"type":"string","example":"May_2022","description":"Name of version of currency scheme."},"vintageDescription":{"type":"string","example":"May 2022 exchange rates","description":"Description of version of currency scheme."},"currencySchemeCode":{"type":"string","default":"","description":"Code of currency scheme. Currency scheme vintage is version of this currency scheme."},"effectiveDate":{"type":"string","format":"date","example":"2022-05-03","description":"Effective date of exchange rates of this vintage of currency scheme."}}},"encoding":{"file":{"contentType":"application/octet-stream"}}}}},"responses":{"200":{"description":"CurrencyExchangeRates loaded for the CurrencySchemeVintage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyExchangeRateUploadResult"}}}},"400":{"description":"Invalid Input Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Job failed with error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referenceTables/eventRateAndScheme/file":{"post":{"tags":["Event Rate Schemes"],"summary":"Create event rate scheme from file","operationId":"postEventRatesAndSchemeFromFile","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["eventRateSchemeName","file","modelRegionCode","modelVersionCode","perilCode"],"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Flat file that maps `eventId` values to `eventRate` values in CSV format. \n\n- File must include header row.\n- File must use tilde character (`~`) as text delimiter.\n- File must be smaller 20MB in size."},"eventRateSchemeName":{"type":"string","description":"Name of event rate scheme."},"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`)","enum":["CS","EQ","FL","TR","WF","WS","WT"]},"modelRegionCode":{"type":"string","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril e.g. _ACEQ_, _EUFL_. For information about models and model updates, see [Models and Data](https://support.rms.com/group/rms/peril-models) in the Moody's Support Center."},"modelVersionCode":{"type":"string","description":"Code of model version.","example":17},"isDefault":{"type":"boolean","description":"If `true`, is default event rate scheme.","default":false},"externalId":{"type":"string","description":"External ID of event rate scheme."}}},"encoding":{"file":{"contentType":"application/octet-stream"}}}}},"responses":{"200":{"description":"Rates loaded for the scheme","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventRateUploadResult"}}}},"400":{"description":"Invalid Input Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Job failed with error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/data-store/referencetables/currency":{"get":{"summary":"Search currencies","operationId":"getCurrencies","tags":["Currencies"],"parameters":[{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"},{"$ref":"#/components/parameters/whereParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/sortOrderParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"Number of currencies returned.","example":257},"totalCount":{"type":"integer","description":"Total number of currencies.","example":257},"items":{"type":"array","description":"Currency","items":{"type":"object","properties":{"currencyId":{"type":"integer","description":"ID of currency.","example":1000005},"currencyCode":{"type":"string","description":"Code that identifies currency.","maxLength":3,"example":"USD"},"currencyName":{"type":"string","description":"Name of currency.","example":"krone"},"countryName":{"type":"string","description":"Name of country of currency.","example":"Denmark"},"currencySymbol":{"type":"string","description":"Symbol for currency.","example":"DKK"},"isActive":{"type":"boolean","description":"If `true`, currency is active.","example":true,"default":true},"externalId":{"type":"string","description":"External ID of currency."},"createUserId":{"type":"string","description":"ID of <<glossary:principal>> that created currency.","example":"abc@company.com"},"createDate":{"type":"string","description":"Date that currency was created.","format":"date-time","example":"2021-06-16T19:36:36.767Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"},"updateUserId":{"type":"string","description":"ID of <<glossary:principal>> that updated currency.","example":"abc@company.com"},"updateDate":{"type":"string","description":"Effective date of currency.","format":"date-time","example":"2021-06-16T19:36:36.490Z","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}T\\\\d{2}:\\\\d{2}:\\\\d{2}\\\\.\\\\d{3}Z$"}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Currencies"],"summary":"Upsert currencies","operationId":"upsertCurrencies","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["currencyCode"],"properties":{"currencyId":{"type":"integer","description":"ID of currency.","minimum":1},"countryName":{"type":"string","description":"Name of currency country.\n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`."},"currencyCode":{"type":"string","description":"Custom code that identifies the currency. \n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`.","maxLength":3,"example":"LMN"},"currencySymbol":{"type":"string","description":"Symbol that identifies currency.","maximum":16},"currencyName":{"type":"string","description":"Name of currency.\n\nUnsupported characters: `\\n` (new line), `\\r` (return), `\\t` (tab), `%`, `'`, `<`, `>`, `/`, `?`, `*`, `(`, `)`.","maximum":16},"externalId":{"type":"string","description":"External ID of currency.","nullable":true}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"inserted":{"type":"integer","description":"Number of currencies inserted.","example":5},"updated":{"type":"integer","description":"Number of currencies updated.","example":5},"failed":{"type":"integer","description":"Number of currency upserts that failed.","example":1},"duplicateRowsCount":{"type":"integer","description":"Number of duplicate rows.","example":0},"failReportPath":{"type":"string"},"reportLink":{"type":"string"},"errors":{"type":"string"},"duplicateRows":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"parameters":{"offsetParam":{"name":"offset","in":"query","description":"Number of items to skip.","required":false,"schema":{"type":"integer","format":"int32","default":0}},"limitParam":{"name":"limit","in":"query","description":"Number of records returned per page.","required":false,"schema":{"type":"integer","format":"int32"}},"whereParam":{"name":"where","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","required":false,"schema":{"type":"string"}},"sortParam":{"name":"sort","in":"query","description":"Name of property on which returned records are sorted.","required":false,"schema":{"type":"string"}},"sortOrderParam":{"name":"sortOrder","in":"query","description":"Sort order. One of `1` (ascending) or `-1` (descending).","required":false,"schema":{"type":"number","enum":[1,-1]}}},"schemas":{"EventRateUploadResult":{"type":"object","properties":{"eventRateSchemeId":{"type":"integer","description":"ID of event rate scheme.","format":"int64","example":15000036},"eventRatesCount":{"type":"integer","format":"int64","description":"Number of event rates."},"errors":{"type":"string"}}},"CurrencyExchangeRateUploadResult":{"type":"object","properties":{"currencySchemeCode":{"type":"string","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","example":"CAD"},"currencyExchangeRateCount":{"type":"integer","format":"int64"},"errors":{"type":"string"}}},"Success":{"type":"object","properties":{"message":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"logId":{"type":"string"}}},"DomainTablesResult":{"type":"object","properties":{"inserted":{"type":"number"},"updated":{"type":"number"},"failed":{"type":"number"},"duplicateRowsCount":{"type":"number","description":"Number of duplicate rows in file."},"failReportPath":{"type":"string"},"reportLink":{"type":"string"},"errors":{"type":"string"},"duplicateRows":{"type":"string"}}},"CurrencyExchangeRates":{"required":["currencyCode","exchangeRate"],"type":"object","properties":{"currencyCode":{"description":"Code that identifies a currency.","type":"string","maxLength":3,"example":"LMN"},"exchangeRate":{"type":"number","description":"Rate of exchange between the currency specified by the `currencyCode` and the <<glossary:anchor currency>> specified in the currency scheme.","format":"double"},"isDerived":{"type":"boolean","description":"If `true`, currency exchange rate is derived."}}},"CurrencySchemeExchangeRates":{"required":["currencySchemeCode","effectiveDate","vintage"],"type":"object","properties":{"createUserId":{"type":"string","description":"ID of <<glossary:principal>> that created exchange rate.","example":"user.name@company.com"},"createDate":{"type":"string","format":"date-time","description":"Date that exchange rate was created."},"updateUserId":{"type":"string","description":"ID of <<glossary:principal>> that last updated exchange rate.","example":"user.name@company.com"},"updateDate":{"type":"string","description":"Date that exchange rate was last updated.","format":"date-time"},"currencySchemeCode":{"type":"string","example":"RMS","description":"Name of <<glossary:currency scheme>> used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`)."},"effectiveDate":{"type":"string","format":"date","example":"2022-05-03","description":"Effective date of exchange rates in this vintage of the currency scheme."},"vintage":{"type":"string","example":"May_2022","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`)."},"anchorCurrencyCode":{"type":"string","description":"Three-letter ISO 4217 code of currency used to calculate currency exchange rates.","maxLength":3,"example":"USD"},"vintageDescription":{"type":"string","example":"May 2022 exchange rates","description":"Description of currency scheme vintage.","nullable":true},"exchangeRates":{"type":"array","description":"Mapping of currency code to exchange rates.","items":{"$ref":"#/components/schemas/CurrencyExchangeRates"}}}},"CurrencySchemeExchangeRatesPost":{"required":["currencySchemeCode","effectiveDate","vintage"],"type":"object","properties":{"currencySchemeCode":{"type":"string","description":"Currency scheme used to calculate the value of specified currency (`currencyCode`) based on the exchange rate between that currency and the scheme's <<glossary:anchor currency>> at the specified point in time (`vintage`).","maxLength":3},"effectiveDate":{"type":"string","format":"date","example":"2022-05-03","description":"Effective date of exchange rates in this vintage of currency scheme."},"vintage":{"type":"string","example":"May_2022","description":"Version of <<glossary:currency scheme>> that defines exchange rate between the <<glossary:anchor currency>> and the specified currency (`currencyCode`)."},"vintageDescription":{"type":"string","example":"May 2022 exchange rates","description":"Description of currency scheme version."},"exchangeRates":{"description":"Maps `currencyCode` to `exchangeRate`. The `exchangeRate` specified the rate of exchange  between the specified `currencyCode` and the anchor currency.","type":"array","items":{"$ref":"#/components/schemas/CurrencyExchangeRates"}}}},"DomainTables":{"type":"object","properties":{"domainName":{"type":"string"},"tableSpace":{"type":"string"},"tableName":{"type":"string"},"tableDescription":{"type":"string"},"dataOwnedBy":{"type":"string"},"approxDataSize":{"type":"string"},"exposeInNotebook":{"type":"boolean"},"primaryKey":{"type":"string"},"naturalKey":{"type":"string"},"isActive":{"type":"boolean"},"schema":{"$ref":"#/components/schemas/DomainTablesSchema"},"filterOptions":{"type":"string"},"autoIdKey":{"type":"string"}}},"DomainTablesSchema":{"type":"object","properties":{"type":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DomainTablesSchemaField"}}}},"DomainTablesSchemaField":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"nullable":{"type":"boolean"},"metadata":{"type":"object"}}},"DomainTablesCollectionResponse":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"count":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int64"}}},"AccumulationSetObject":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/AccumulationSetObject"}}},"CollectionResponseAlmProfile":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AlmProfile"}}}},"AlmProfile":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"profileName":{"type":"string"},"profileType":{"type":"string"},"country":{"type":"string"},"peril":{"type":"string","description":"Natural or man-made event that causes a financial loss.","enum":["Earthquake","Flood"]},"rmsLob":{"type":"string"},"geoRes":{"type":"string"},"trackingId":{"type":"string"},"descFin":{"type":"string"},"descReg":{"type":"string"},"descInv":{"type":"string"},"dataTab":{"type":"string"},"softwareVersionCode":{"type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]},"modelRegionCode":{"type":"string","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril e.g. _ACEQ_, _EUFL_. For information about models and model updates, see [Models and Data](https://support.rms.com/group/rms/peril-models) in the Moody's Support Center."},"modelDataVersion":{"type":"string"},"petDataVersion":{"type":"string"},"petStartYear":{"type":"string"},"petNumberOfPeriods":{"type":"integer","format":"int32"},"numberOfSamples":{"type":"integer","format":"int32"},"ispla":{"type":"boolean"},"gmpe":{"type":"string"},"subperil":{"type":"string"},"eventRateSchemeId":{"type":"integer","format":"int32","description":"ID of event rate scheme.","example":15000036},"alternateVuln":{"type":"string"},"petId":{"type":"integer","format":"int32"}}},"AlmAutoAttachItem":{"type":"object","properties":{"geoResCode":{"type":"string"},"countryCode":{"type":"string"},"rmsLobs":{"type":"array","items":{"type":"string"}}}},"AlmAutoAttachRequest":{"type":"object","properties":{"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","enum":["CS","EQ","FL","TR","WF","WS","WT"]},"softwareVersionCode":{"type":"string","description":"Engine to be used in the analysis, e.g. _RL18_.","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]},"includeHD":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AlmAutoAttachItem"}}}},"AlmMapLob":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"countryCode":{"type":"string"},"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`)."},"rmsLob":{"type":"string"},"newLob":{"type":"string"},"trackingIds":{"type":"array","items":{"type":"string"}},"softwareVersionCode":{"type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]}}},"CollectionResponseAlmMapLob":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/AlmMapLob"}}}},"ModelProfileRequest":{"required":["analysisType","modelRegionCode","modelSourceCode","name","peril","region","softwareVersionCode"],"type":"object","properties":{"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss. \n\n- DLM model profiles accept Earthquake, Flood, Severe Convective Storm, Windstorm, and Winterstorm perils.\n- HD model profiles accept Earthquake, Flood, Severe Convective Storm, Terrorism, Wildfire, and Windstorm perils.","enum":["Earthquake","Flood","Severe Convective Storm","Terrorism","Wildfire","Windstorm","Winterstorm"]},"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. \n\nPerils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","enum":["CS","EQ","FL","TR","WF","WS","WT"]},"region":{"type":"string","description":"Region covered by the model profile, e.g. Austrailia, Caribbean, Central America, China \n\nSee [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)."},"modelRegionCode":{"type":"string","description":"Four-letter code comprised of a two-letter code for the region and a two-letter code for the peril e.g. _ACEQ_, _EUFL_. For information about models and model updates, see [Models and Data](https://support.rms.com/group/rms/peril-models) in the Moody's Support Center."},"modelSourceCode":{"type":"string","description":"Source of the engine to be used in the analysis, e.g. _RMS_"},"softwareVersionCode":{"description":"Version of model engine used in model profile.","type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL13","RL13.1","RL15","RL16","RL17","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24","PLTALM1.0","PLTGroup1.0","Unrecognized"]},"name":{"type":"string","description":"Name of model profile. Moody's recommends that establish a naming convention that will help you identify the profile you want to use for an analysis."},"analysisType":{"type":"string","description":"Type of analysis. Examples include `Exceedance Probability` and `Scenario`.","enum":["CA DOI","Exceedance Probability","Footprint File","Hazard Curve","Historical","Maximum Credible","Maximum Historical","Non-Runnable","Scenario","Simulated","User Defined"]},"dlmJson":{"type":"string"},"subRegions":{"type":"string","description":"Subregion within the specified `region`, e.g. `Belgium` is a subregion within `EU`\n\nSee [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)"},"templateId":{"type":"integer","nullable":true}}},"ModelProfile":{"required":["createdAt","createdBy","templateId"],"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of model profile."},"peril":{"type":"string","description":"Natural or man-made phenomenon that generates insurance loss."},"perilCode":{"type":"string","description":"Two-letter code that identifies a natural or man-made phenomenon that generates insurance loss. Perils include earthquake (`EQ`), flood (`FL`), severe convective storm (`CS`), terrorism (`TR`), wildfire (`WF`),  windstorm/hurricane/cyclone/typhoon (`WS`), and winterstorm (`WT`).","enum":["CS","EQ","FL","TR","WF","WS","WT"]},"region":{"type":"string","description":"Region covered by the model profile, e.g. Austrailia, Caribbean, Centeral America, China \n\nSee [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm)"},"modelRegionCode":{"type":"string","description":"Code for region covered by the model profile, e.g. `AU`, `CB`, `AC`, `CC`"},"subRegions":{"type":"string","description":"Subregions within the specified `region`."},"modelSourceCode":{"type":"string"},"softwareVersionCode":{"description":"Version of DLM or HD model used by model profile. See [Models Available in Risk Modeler](https://help.rms.com/help/RiskModeler/prod/Content/HIGH/Models.htm)","type":"string","enum":["HDv1.0","HDv1.1","HDv1.2","HDv2.0","HDv2.1","HDv3.0","RL18","RL18.1","RL18.2","RL21","RL22","RL23","RL24"]},"analysisType":{"type":"string","description":"Type of analysis. Examples include `Exceedance Probability` and `Scenario`.","enum":["CA DOI","Exceedance Probability","Footprint File","Hazard Curve","Historical","Maximum Credible","Maximum Historical","Non-Runnable","Scenario","Simulated","User Defined"]},"name":{"type":"string","description":"Name of model profile."},"dlmJson":{"type":"string"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created batch template, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"createdAt":{"type":"string","format":"date-time","description":"Date created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. _2020-01-01T00:00:00.000Z_"},"templateId":{"type":"integer","nullable":true},"rmsDefault":{"type":"boolean","nullable":true}}},"CollectionResponseModelProfile":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ModelProfile"}}}},"SettingsIdentifier":{"type":"object","properties":{"name":{"type":"string","description":"Name of output profile."},"id":{"type":"integer","format":"int32","description":"ID of output profile."}}},"ModelProfileEditRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of model profile."}}},"OutputSettings":{"required":["metricRequests"],"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of output profile.","example":67},"name":{"type":"string","description":"Name of output profile.","example":"Account-Worker Compensation-EP"},"metricRequests":{"type":"array","items":{"$ref":"#/components/schemas/OutputMetricRequest"}},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created output profile, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"createdAt":{"type":"string","description":"Date that output profile was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","example":"2024-06-13T00:36:12.260+00:00"},"rmsDefault":{"description":"Indicates whether RMS default metrics are returned.","type":"boolean","nullable":true},"isDefault":{"description":"Indicates whether this is the default output profile.","type":"boolean","nullable":true}}},"OutputMetricsResponse":{"type":"object","properties":{"metricRequests":{"type":"array","items":{"$ref":"#/components/schemas/OutputMetricRequest"}}}},"OutputSettingsRequest":{"required":["metricRequests"],"type":"object","properties":{"name":{"description":"Name of output profile.","type":"string"},"excludeDefaultMetrics":{"type":"boolean","description":"Output required for grouping and post-analysis treaty editing is returned by default. If `true`, the analysis does not return default output and only returns output data for granularities and financial perspectives specified in the output profile.","default":false},"metricRequests":{"type":"array","description":"List of metrics to return. Each object maps a metric type to a financial perspective and one or more granularities.","items":{"$ref":"#/components/schemas/OutputMetricRequest"}}}},"OutputSettingsMetadata":{"type":"object","properties":{"name":{"description":"Name of output profile.","type":"string","example":"Account-Worker Compensation-EP"},"createdBy":{"description":"Login of <<glossary:principal>> that created output profile, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","type":"string","format":"email","example":"user.name@company.com"},"createdAt":{"type":"string","description":"Date that output profile was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","example":"2024-06-13T00:36:12.260+00:00"},"id":{"description":"ID of output profile.","type":"integer","format":"int32","example":67},"rmsDefault":{"description":"Indicates whether RMS default metrics are returned.","type":"boolean","nullable":true}}},"OutputMetricRequest":{"required":["granularity","includeIntermediateSums","metricType","perspective"],"type":"object","properties":{"perspective":{"description":"Financial perspective that identfies the financial structures considered in the calculation of losses. See [Financial Perspectives](financial-perspectives).","example":"GR"},"metricType":{"description":"Type of metrics included in results.","type":"string","example":"EP","enum":["DAMAGE","EP","HAZARD","LOSS_TABLES","STATS","UNCERTAINTY"]},"granularity":{"description":"Granularity that specifies the resolution of data.\n\n`Account`, `Account by LOB`, `Account by Loss Type`, `Admin1 Account`, `Admin1 by Cedant`, `Admin1 by LOB`, `Admin1 by LOB by Cedant`, `Admin1 by Loss Type`, `Admin2`, `Admin2 by Cedant`, `Admin2 by LOB`, `Admin2 by LOB by Cedant`, `Admin2 by Loss Type`, `Building`, `Building People Group`, `Building by Loss Type`, `Cedant`, `City`, `City by LOB`, `Country`, `Country by Cedant`, `Country by LOB`, `Country by LOB by Cedant`, `Country by Loss Type`, `Cresta`, `Cresta by Cedant`, `Cresta by LOB`, `Cresta by LOB by Cedant`, `Cresta by Loss Type`, `District`, `District by LOB`, `Facultative`, `LOB`, `Location`, `Location by Loss Type`, `Loss Type`, `Loss Type by Cedant`, `Loss Type by LOB`, `Loss Type by LOB by Cedant`, `Other GeoID`, `Other GeoID by LOB`, `Policy`, `Policy Special Conditions`, `Policy by Loss Type`, `Portfolio`, `PostalCode`, `PostalCode by Cedant`, `PostalCode by LOB`, `PostalCode by LOB by Cedant`, `PostalCode by Loss Type`","type":"array","items":{"type":"string","example":"Portfolio","enum":["Account","Account by LOB","Account by Loss Type","Admin1 Account","Admin1 by Cedant","Admin1 by LOB","Admin1 by LOB by Cedant","Admin1 by Loss Type","Admin2","Admin2 by Cedant","Admin2 by LOB","Admin2 by LOB by Cedant","Admin2 by Loss Type","Building","Building People Group","Building by Loss Type","Cedant","City","City by LOB","Country","Country by Cedant","Country by LOB","Country by LOB by Cedant","Country by Loss Type","Cresta","Cresta by Cedant","Cresta by LOB","Cresta by LOB by Cedant","Cresta by Loss Type","District","District by LOB","Facultative","LOB","Location","Location by Loss Type","Loss Type","Loss Type by Cedant","Loss Type by LOB","Loss Type by LOB by Cedant","Other GeoID","Other GeoID by LOB","Policy","Policy Special Conditions","Policy by Loss Type","Portfolio","PostalCode","PostalCode by Cedant","PostalCode by LOB","PostalCode by LOB by Cedant","PostalCode by Loss Type"]}},"includeIntermediateSums":{"description":"Non-EP HD analysis only. If `true`, intermediate `HAZARD` and `UNCERTAINTY` sums are included in results.","type":"boolean","example":false}}},"LossLocationMetric":{"required":["granularity","includeIntermediateSums","lossLocation","metricType","outputLevelCode","perspective"],"type":"object","properties":{"perspective":{"type":"string"},"metricType":{"type":"string"},"granularity":{"type":"array","description":"List of objects that map metric type to a financial perspective and one or more granularities.","items":{"type":"string","example":"Portfolio","enum":["Account","Account by LOB","Account by Loss Type","Admin1 Account","Admin1 by Cedant","Admin1 by LOB","Admin1 by LOB by Cedant","Admin1 by Loss Type","Admin2","Admin2 by Cedant","Admin2 by LOB","Admin2 by LOB by Cedant","Admin2 by Loss Type","Building","Building People Group","Building by Loss Type","Cedant","City","City by LOB","Country","Country by Cedant","Country by LOB","Country by LOB by Cedant","Country by Loss Type","Cresta","Cresta by Cedant","Cresta by LOB","Cresta by LOB by Cedant","Cresta by Loss Type","District","District by LOB","LOB","Location","Location by Loss Type","Loss Type","Loss Type by Cedant","Loss Type by LOB","Loss Type by LOB by Cedant","Other GeoID","Other GeoID by LOB","Policy","Policy Special Conditions","Policy by Loss Type","Portfolio","PostalCode","PostalCode by Cedant","PostalCode by LOB","PostalCode by LOB by Cedant","PostalCode by Loss Type"]}},"outputLevelCode":{"type":"integer","format":"int32"},"includeIntermediateSums":{"type":"boolean"},"lossLocation":{"type":"string"}}},"LossLocationResponse":{"required":["supportingFilesRoot"],"type":"object","properties":{"supportingFilesRoot":{"type":"string"},"metricRequests":{"type":"array","items":{"$ref":"#/components/schemas/LossLocationMetric"}}}},"LossDirectoriesRequest":{"required":["analysisId","metricRequests","tenantId","workflowId"],"type":"object","properties":{"tenantId":{"type":"string"},"workflowId":{"type":"string"},"analysisId":{"type":"string"},"metricRequests":{"type":"array","items":{"$ref":"#/components/schemas/OutputMetricRequest"}}}},"BatchTemplateSummary":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":1369,"readOnly":true},"name":{"type":"string","description":"Name of batch template","example":"Acc_SS"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created batch template, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"createdAt":{"type":"string","format":"date-time","example":"2025-07-14T09:58:24.870+00:00","description":"Date created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. _2020-01-01T00:00:00.000Z_","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","example":"2025-07-14T10:00:03.484+00:00","description":"Date modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. _2020-01-01T00:00:00.000Z_","readOnly":true},"entitlement":{"type":"string","description":"<<glossary:Entitlement>> required to view batch template."},"isDefault":{"type":"boolean","description":"If `true`, is default batch template.","default":false}}},"BatchTemplate":{"allOf":[{"$ref":"#/components/schemas/BatchTemplateSummary"},{"type":"object","properties":{"settings":{"type":"string","description":"JSON string containing the complete batch template settings and configuration."}}}]},"BatchTemplateCreateRequest":{"type":"object","required":["name","settings","entitlement"],"properties":{"name":{"type":"string","description":"Name of batch template.","example":"Test_Batch_Template_API_1"},"settings":{"type":"string","description":"Batch template settings and configuration in JSON format."},"entitlement":{"type":"string","description":"Entitlement used to create job.","enum":["RI-UNDERWRITEIQ"]}}},"BatchTemplateUpdateRequest":{"type":"object","properties":{"name":{"type":"string"},"settings":{"type":"string","description":"JSON string containing the batch template settings and configuration."},"entitlement":{"type":"string"},"isDefault":{"type":"boolean"}}}},"securitySchemes":{"rms_bearer_auth":{"type":"http","description":"RMS tenant specific bearer token to make authorized requests with temporary life span","scheme":"bearer","bearerFormat":"JWT"},"rms_api_key":{"type":"apiKey","name":"Authorization","description":"RMS tenant specific api key to make authorized requests","in":"header"}}}}