{"openapi":"3.0.2","info":{"title":"Reference Data API","version":"2026.03.b"},"servers":[{"url":"https://{host}/platform/referencedata/v1","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com"}}}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["curl","java","csharp","node","python"],"proxy-enabled":true,"samples-enabled":true},"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"paths":{"/predefinedconditions":{"get":{"tags":["Predefined Conditions"],"summary":"Search predefined conditions","operationId":"searchPredefinedConditions","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property    | Type | Comparison                      | List           |\n| :---------- | :-------- | :------------------------------ | :------------- |\n| `conditionType` | `string`  | `=`, `!=`   | `IN`, `NOT IN` |\n| `predefinedConditionId`  | `number` | `=`, `!=`, `<`, `>`, `<=`, `>=` | `IN`, `NOT IN` |\n| `predefinedConditionName`  | `string` | `=`, `!=`, `LIKE`, `NOT LIKE` | `IN`, `NOT IN` |\n\nUse the `AND` and `OR `logical operators to form compound queries. See [Filtering Responses](doc:filtering-responses).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending): `conditionType`, `createDate`, `createdBy`, `predefinedConditionName`, `updateDate`, `updatedBy`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of retrieved records to display on the page.","schema":{"maximum":1000,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at '0'.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PredefinedCondition"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Predefined Conditions"],"summary":"Create predefined condition","operationId":"createPredefinedCondition","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedCondition"}}},"required":true},"responses":{"201":{"description":"Predefined condition is successfully created.","headers":{"Location":{"description":"location of the new predefined condition","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/predefinedconditions/{predefinedConditionId}":{"patch":{"tags":["Predefined Conditions"],"summary":"Update predefined condition","operationId":"updatePredefinedCondition","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","example":13,"required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedCondition"}}}},"responses":{"204":{"description":"Predefined condition is successfully updated"},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Predefined Conditions"],"summary":"Delete predefined condition","operationId":"deletePredefinedCondition","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","example":13,"required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Predefined condition is successfully deleted"},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/predefinedconditions/{predefinedConditionId}/criteria":{"get":{"tags":["Predefined Conditions"],"summary":"List predefined condition criteria","operationId":"listPredefinedConditionCriteria","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","example":34,"required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PredefinedConditionCriteria"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Predefined Conditions"],"summary":"Create predefined condition criteria","operationId":"createPredefinedConditionCriteria","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","example":35,"required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedConditionCriteria"}}},"required":true},"responses":{"201":{"description":"Predefined condition criteria successfully created","headers":{"Location":{"description":"Location of the new predefined condition criteria","style":"simple","schema":{"$ref":"#/components/schemas/ErrorMessage","type":"string","format":"URI"}}}},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/predefinedconditions/{predefinedConditionId}/criteria/{predefinedConditionCriteriaId}":{"get":{"tags":["Predefined Conditions"],"summary":"Get predefined condition criteria","operationId":"getPredefinedConditionCriteria","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"predefinedConditionCriteriaId","in":"path","description":"ID of predefined condition criteria.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK\n\nInformation for the specified predefined condition criteria was successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedConditionCriteria"}}}},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Predefined Conditions"],"summary":"Update predefined condition criteria","operationId":"updatePredefinedConditionCriteria","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"predefinedConditionCriteriaId","in":"path","description":"ID of predefined condition criteria.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredefinedConditionCriteria"}}},"required":true},"responses":{"204":{"description":"Predefined condition criteria successfully updated."},"400":{"description":"Bad Request: Please check that you are provided all required values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden: Access to this resource has been denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Predefined Conditions"],"summary":"Delete predefined condition criteria","operationId":"deletePredefinedConditionCriteria","parameters":[{"name":"predefinedConditionId","in":"path","description":"ID of predefined condition.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"predefinedConditionCriteriaId","in":"path","description":"ID of predefined condition criteria.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Predefined condition criteria successfully deleted."},"400":{"description":"Bad Request: Please check that you are provided all required\nvalues.","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"}}}}}}},"/update-rollup-defaults":{"post":{"summary":"Update rollup defaults","operationId":"updateRollupDefaults","tags":["Rollup Defaults"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"pricingConditions":{"type":"array","items":{"type":"object","properties":{"earliestInceptionDate":{"type":"string","format":"date"},"latestInceptionDate":{"type":"string","format":"date"},"earliestExpirationDate":{"type":"string","format":"date"},"latestExpirationDate":{"type":"string","format":"date"},"brokers":{"type":"array","items":{"type":"string"}},"offices":{"type":"array","items":{"type":"string"}},"businessUnits":{"type":"array","items":{"type":"string"}},"legalEntities":{"type":"array","items":{"type":"string"}},"quoteStatuses":{"type":"array","items":{"type":"string"}},"corporateFormulaUuid":{"type":"string","format":"uuid"},"technicalFormulaUuid":{"type":"string","format":"uuid"}}}},"allowPricingConditionOverride":{"type":"boolean"},"allowTechnicalPricingEdits":{"type":"boolean"},"calculateCorporate":{"type":"boolean"},"calculateTechnical":{"type":"boolean"},"calculateOffered":{"type":"boolean"}}}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/rollup-defaults":{"get":{"summary":"Get rollup defaults","operationId":"getRollupDefaults","tags":["Rollup Defaults"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollupDefaults"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/models":{"get":{"tags":["Rollup Models"],"summary":"Search rollup models","operationId":"searchRollupModels","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. See [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Number of the page  displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination).","schema":{"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending). See [Response Pagination](doc:response-pagination).","schema":{"type":"string","example":"modelName,createdBy desc"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelListItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Rollup Models"],"summary":"Create rollup model","operationId":"createRollupModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelCreate"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelCreated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/models/{uuid}":{"get":{"tags":["Rollup Models"],"summary":"Get rollup model","operationId":"getRollupModel","parameters":[{"name":"uuid","in":"path","description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelListItem"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Rollup Models"],"summary":"Delete rollup model","operationId":"deleteRollupModel","parameters":[{"name":"uuid","in":"path","required":true,"description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Rollup Models"],"summary":"Update rollup model","operationId":"patchRollupModel","parameters":[{"name":"uuid","in":"path","description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelPatch"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/modelsets":{"get":{"tags":["Rollup Model Sets"],"summary":"Search rollup model sets","operationId":"searchrollupmodelsets","parameters":[{"name":"isDefault","in":"query","description":"If `true` returns default rollup model sets.","content":{"application/":{"schema":{"type":"boolean"}}}},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","default":100}},{"name":"includeDeleted","in":"query","description":"If `true`, deleted rollup model sets are returned.","content":{"application/json":{"schema":{"type":"boolean","default":false}}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSets"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Rollup Model Sets"],"summary":"Create rollup model set","operationId":"createrollupmodelset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSet"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSetCreatedOrUpdated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/modelsets/{modelSetUuid}":{"get":{"tags":["Rollup Model Sets"],"summary":"Get rollup model set","operationId":"getrollupmodelset","parameters":[{"name":"modelSetUuid","in":"path","description":"UUID of rollup model set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"minimum":1,"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Rollup Model Sets"],"summary":"Update rollup model set","operationId":"updaterollupmodelset","parameters":[{"name":"modelSetUuid","in":"path","description":"UUID of rollup model set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"minimum":1,"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSetCreateOrUpdate"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Rollup Model Sets"],"summary":"Delete rollup model set","operationId":"deleterollupModelSet","parameters":[{"name":"modelSetUuid","in":"path","description":"UUID of rollup model set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"minimum":1,"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/modelsettingssets":{"get":{"tags":["Rollup Model Settings Sets"],"summary":"Search rollup model settings sets","operationId":"SearchRollupModelSettingsSets","parameters":[{"name":"filter","in":"query","description":"Filter","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Limit","schema":{"type":"integer","format":"int32","default":100}},{"name":"sort","in":"query","description":"Sort","schema":{"type":"string","example":"modelSettingsSetName,createdAt,updatedAt desc"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelSettingsSetListItem"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Rollup Model Settings Sets"],"summary":"Create rollup model settings set","operationId":"createRollupModelSettingsSet","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSettingsSetCreate"}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSettingsSetCreated"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/modelsettingssets/{uuid}":{"get":{"tags":["Rollup Model Settings Sets"],"summary":"Get rollup model settings set","operationId":"getRollupModelSettingsSet","parameters":[{"name":"uuid","in":"path","description":"UUID of rollup model settings set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSettingsSet"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Rollup Model Settings Sets"],"summary":"Delete rollup model settings set","operationId":"deleteRollupModelSettingsSet","parameters":[{"name":"uuid","in":"path","description":"UUID of rollup model settings set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"minimum":1,"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Rollup Model Settings Sets"],"summary":"Update rollup model settings set","operationId":"updateRollupModelSettingsSet","parameters":[{"name":"uuid","in":"path","description":"UUID of rollup model settings set.","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schema":{"minimum":1,"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelSettingsSetPatch"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/rollupmetadata":{"get":{"tags":["Rollup Metadata"],"summary":"Search rollup metadata","operationId":"searchRollupMetadata","parameters":[{"name":"metadataType","in":"query","description":"<<glossary:Query string>> to filter response data by metadata type. One of `PROGRAM` or `TREATY`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RollupMetadata"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/rollupmetadata/{metadataUuid}":{"get":{"tags":["Rollup Metadata"],"summary":"Get rollup metadata","operationId":"getRollupMetadata","parameters":[{"name":"metadataUuid","in":"path","description":"UUID of metadata record.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollupMetadata"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Rollup Metadata"],"summary":"Update rollup metadata","operationId":"updateRollupMetadata","parameters":[{"name":"metadataUuid","in":"path","description":"Metadata uuid.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollupMetadataPatch"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"possibleValues not applicable when inputType is STRING","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/tags":{"get":{"tags":["Tags"],"summary":"Search tags","operationId":"getTags","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property    | Type | Comparison                      | List           |\n| :---------- | :-------- | :------------------------------ | :------------- |\n| `createdBy` | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `isActive`  | `boolean` | `=`, `!=`                       | `IN`, `NOT IN` |\n| `tagId`     | `number`  | `=`, `!=`, `<`, `>`, `<=`, `>=` | `IN`, `NOT IN` |\n| `tagName`   | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `updatedBy` | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"minimum":1,"type":"integer","format":"int32","default":5000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Tags"],"summary":"Create tag","operationId":"createTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"location of the resource created","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/tagGroups":{"get":{"tags":["Tag Groups"],"summary":"Search tag groups","operationId":"getTagGroups","parameters":[{"name":"isActive","in":"query","schema":{"type":"boolean"},"example":true},{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n| Property       | Type | Comparison                      | List           |\n| :------------- | :-------- | :------------------------------ | :------------- |\n| `createdBy`    | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `isActive`     | `boolean` | `=`, `!=`                       | `IN`, `NOT IN` |\n| `tagGroupId`   | `number`  | `=`, `!=`, `<`, `>`, `<=`, `>=` | `IN`, `NOT IN` |\n| `tagGroupName` | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |\n| `updatedBy`    | `string`  | `=`, `!=`, `LIKE`, `NOT LIKE`   | `IN`, `NOT IN` |","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"minimum":0,"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"minimum":1,"type":"integer","format":"int32","default":5000}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagGroup"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"post":{"tags":["Tag Groups"],"summary":"Create tag group","operationId":"createTagGroup","requestBody":{"description":"TagGroup from payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagGroup"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"location of the created resource","schema":{"type":"string","format":"uri"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/tagGroups/{tagGroupId}":{"get":{"tags":["Tag Groups"],"summary":"Get tag group","operationId":"getTagGroup","parameters":[{"name":"tagGroupId","description":"ID of tag group.","example":45,"in":"path","required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagGroup"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"put":{"tags":["Tag Groups"],"summary":"Update tag group","operationId":"updateTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"ID of tag group.","example":23,"required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"description":"structure to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagGroup"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"delete":{"tags":["Tag Groups"],"summary":"Delete tag group","operationId":"deleteTagGroup","parameters":[{"name":"tagGroupId","in":"path","description":"ID of tag group.","example":23,"required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/tags/{tagId}":{"get":{"tags":["Tags"],"summary":"Get tag","operationId":"getTagById","parameters":[{"name":"tagId","description":"ID of this tag.","in":"path","example":4,"required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}},"patch":{"tags":["Tags"],"summary":"Update tag","operationId":"updateTag","parameters":[{"name":"tagId","description":"ID of tag to update.","in":"path","example":4,"required":true,"schema":{"minimum":1,"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}},"components":{"schemas":{"ModelCreate":{"required":["modelName","modelType","perilCode"],"type":"object","properties":{"modelName":{"type":"string","description":"Name of rollup model."},"description":{"type":"string","description":"Description of rollup model."},"modelType":{"type":"string","description":"Type of rollup model.","example":"SIMULATED","enum":["SIMULATED"]},"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`).","example":"EQ"},"countryIds":{"type":"array","items":{"type":"object"},"default":[]},"lobIds":{"type":"array","items":{"type":"object"},"default":[]}}},"ModelSettingsSetCreated":{"required":["uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"UUID of model settings set.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","format":"uuid"}}},"Model":{"required":["adminIds","countryIds","createdAt","createdBy","isActive","isCustom","isExecutable","lobIds","modelName","modelType","perilCode","updatedAt","updatedBy","uuid","validEventRateSchemes","validModelProfiles","validSimulationSets","versionsCount","zoneIds"],"type":"object","properties":{"uuid":{"type":"string","description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","format":"uuid"},"modelName":{"type":"string","description":"Name of rollup model.","example":"P1_QE_E2E_MODEL_174618125480"},"description":{"type":"string","description":"Description of rollup model.","example":"South America Earthquake"},"modelType":{"type":"string","description":"Type of rollup model.","enum":["SIMULATED"]},"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`)."},"regionCode":{"type":"string","description":"Two letter code of region analyzed, e.g. `AU`, `CB`, `AC`, `CC`. See [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm).","example":"AH"},"eventSetVersionCode":{"type":"string","description":"Code of event set version."},"adminIds":{"type":"array","description":"List of Admin IDs.","items":{"type":"object"}},"zoneIds":{"type":"array","description":"List of Zone IDs.","items":{"type":"object"}},"countryIds":{"type":"array","items":{"type":"object"}},"lobIds":{"type":"array","description":"List of Country IDs.","items":{"type":"object"}},"validSimulationSets":{"type":"array","items":{"$ref":"#/components/schemas/ModelSimulationSet"}},"validEventRateSchemes":{"type":"array","items":{"$ref":"#/components/schemas/ModelEventRateScheme"}},"validModelProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ModelModelProfile"}},"isActive":{"type":"boolean","description":"Status of rollup model profile. One of `true`, `false`.","example":true},"isCustom":{"type":"boolean"},"versionsCount":{"type":"integer","format":"int32"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created rollup model, 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":"Timestamp of date rollup model was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-04-21T17:35:27.310459Z"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated rollup model, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of date rollup model was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-04-21T17:35:27.310459Z"},"isExecutable":{"type":"boolean"}}},"ModelVersion":{"required":["modelVersionUuid"],"type":"object","properties":{"modelVersionUuid":{"type":"string","format":"uuid"},"eventDate":{"type":"string","format":"date"}}},"ModelSetModel":{"required":["modelUuid"],"type":"object","properties":{"modelUuid":{"type":"string","format":"uuid","description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"simulationSetId":{"type":"integer","description":"ID of simulation set.","format":"int64"}}},"ModelSet":{"required":["createdAt","createdBy","modelSetName","isDeleted","isScenario","modelVersions","models","modifiedAt","modifiedBy","name","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID of rollup model set.","readOnly":true},"modelSetName":{"type":"string","description":"Name of rollup model set."},"models":{"type":"array","description":"List of rollup models included in rollup model set.","items":{"$ref":"#/components/schemas/ModelSetModel"}},"isDefault":{"type":"boolean","description":"If `true`, is the default rollup model set."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of date that rollup model set was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-04-21T17:35:27.310459Z","readOnly":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created rollup model set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"modifiedAt":{"type":"string","format":"date-time","description":"Timestamp of date that rollup model set was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-04-21T17:35:27.310459Z","readOnly":true},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated rollup model set, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true}}},"ModelSetCreateOrUpdate":{"required":["name"],"type":"object","properties":{"modelSetName":{"type":"string","description":"name of rollup model set."},"models":{"type":"array","description":"List of rollup models included in rollup model set.","items":{"$ref":"#/components/schemas/ModelSetModel"}},"isDefault":{"type":"boolean","description":"If `true`, is the default rollup model set.","default":false}}},"ModelListItem":{"required":["adminIds","countryIds","createdAt","createdBy","isActive","isExecutable","lobIds","modelName","modelType","perilCode","updatedAt","updatedBy","uuid","versionsCount","zoneIds"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"UUID of rollup model.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"modelName":{"type":"string","description":"Name of rollup model.","example":"P1_QE_E2E_MODEL_174618125480"},"description":{"type":"string","description":"Description of rollup model.","example":"South America Earthquake"},"modelType":{"type":"string","description":"Type of rollup model.","enum":["SIMULATED"]},"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`)."},"regionCode":{"type":"string","description":"Two letter code of region analyzed, e.g. `AU`, `CB`, `AC`, `CC`. See [RMS Model Regions and Region Codes](https://help.rms.com/help/RiskModeler/prod/Content/HowTo/ModelRegionCodes.htm).","example":"AH"},"eventSetVersionCode":{"type":"string","description":"Code of event set version."},"adminIds":{"type":"array","description":"List of Admin IDs.","items":{"type":"object"}},"zoneIds":{"type":"array","description":"List of Zone IDs.","items":{"type":"object"}},"countryIds":{"type":"array","description":"List of Country IDs.","items":{"type":"object"}},"lobIds":{"type":"array","description":"List of <<glossary:line of business> IDs.","items":{"type":"object"}},"isActive":{"type":"boolean","description":"Status of rollup model profile. One of `true`, `false`.","example":true},"versionsCount":{"type":"integer","format":"int32","description":"Number of versions of rollup model.","example":5},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created rollup model, 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 rollup model was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","format":"date-time","example":"2025-04-21T17:35:27.310459Z"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated rollup model, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of date rollup model was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`.","example":"2025-04-21T17:35:27.310459Z"},"isExecutable":{"type":"boolean"}}},"ShareSetCreated":{"required":["shareSetId","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"shareSetId":{"type":"integer","format":"int32"}}},"ModelSettingsCreate":{"required":["modelProfileId","modelUuid","outputProfileId","portfolioAnalyzeOption","skipOption","weight"],"type":"object","properties":{"modelUuid":{"type":"string","format":"uuid"},"modelProfileId":{"type":"integer","format":"int32"},"outputProfileId":{"type":"integer","format":"int64"},"eventRateSchemeId":{"type":"object"},"weight":{"type":"number","format":"double"},"portfolioAnalyzeOption":{"type":"string","enum":["All","RiskSourceModelMatch","RiskSourcePerilRegionMatch"]},"skipOption":{"type":"string","enum":["DoNot","ModelProfileMatch","ModelMatch"]}}},"ModelSettingsSetListItem":{"required":["createdAt","createdBy","isDefault","modelSettingsSetName","settings","updatedAt","updatedBy","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"modelSettingsSetName":{"type":"string","description":"Name of model settings set."},"settings":{"type":"array","items":{"$ref":"#/components/schemas/ModelSettings"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> 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"},"isDefault":{"type":"boolean"}}},"ValidationServiceError":{"required":["code","logId","message"],"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidationError"}}}},"FieldValidationError":{"required":["field","messages"],"type":"object","properties":{"field":{"type":"string"},"messages":{"type":"array","items":{"type":"string"}}}},"ServiceError":{"required":["code","logId","message"],"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"}}},"ModelSettingsSet":{"required":["createdAt","createdBy","isDefault","modelSettingsSetName","settings","updatedAt","updatedBy","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"modelSettingsSetName":{"type":"string"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/ModelSettings"}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> 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"},"isDefault":{"type":"boolean"}}},"ModelSets":{"type":"array","items":{"$ref":"#/components/schemas/ModelSet"}},"ModelSetCreatedOrUpdated":{"required":["uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"UUID of rollup model set.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}},"ModelSettingsSetPatch":{"type":"object","properties":{"modelSettingsSetName":{"type":"string","description":"Name of model settings set."},"settings":{"type":"array","items":{"$ref":"#/components/schemas/ModelSettingsCreate"}},"isDefault":{"type":"object"}}},"ShareSetCreate":{"required":["description","isActive","shareSetName"],"type":"object","properties":{"shareSetName":{"type":"string"},"description":{"type":"string"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean","default":false}}},"ModelSettings":{"required":["modelName","modelProfileId","modelUuid","outputProfileId","portfolioAnalyzeOption","skipOption","weight"],"type":"object","properties":{"modelUuid":{"type":"string","format":"uuid"},"modelName":{"type":"string"},"modelProfileId":{"type":"integer","format":"int32"},"outputProfileId":{"type":"integer","format":"int64"},"eventRateSchemeId":{"type":"object"},"weight":{"type":"number","format":"double"},"portfolioAnalyzeOption":{"type":"string","enum":["All","RiskSourceModelMatch","RiskSourcePerilRegionMatch"]},"skipOption":{"type":"string","enum":["DoNot","ModelProfileMatch","ModelMatch"]}}},"ModelSettingsSetCreate":{"required":["modelSettingsSetName","settings"],"type":"object","properties":{"modelSettingsSetName":{"type":"string"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/ModelSettingsCreate"}},"isDefault":{"type":"boolean","default":false}}},"ModelModelProfile":{"required":["id","isRmsDefault","name"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"isRmsDefault":{"type":"boolean"}}},"ModelEventRateScheme":{"required":["id","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"ModelCreated":{"required":["uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"}}},"ShareSet":{"required":["createdAt","createdBy","description","isActive","isDataUploaded","isDefault","modifiedAt","modifiedBy","shareSetId","shareSetName","uuid"],"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"shareSetId":{"type":"integer","format":"int32"},"shareSetName":{"type":"string"},"description":{"type":"string"},"isActive":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDataUploaded":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> 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"},"modifiedAt":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> 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"}}},"ModelSimulationSet":{"required":["id","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"ModelPatch":{"type":"object","properties":{"modelName":{"type":"string","description":"Name of rollup model."},"description":{"type":"string","description":"Description of rollup model."},"defaultModelVersionUuid":{"type":"string","format":"uuid","description":"UUID of default rollup model version."},"isActive":{"type":"object","description":"Status of rollup model profile. One of `true`, `false`."}}},"PatchGeneric":{"required":["targetProperty","value"],"type":"object","properties":{"operation":{"type":"string","default":"UPDATE","enum":["UPDATE","ADD","REMOVE"]},"targetProperty":{"type":"string"},"value":{"type":"string"}}},"Tag":{"required":["tagName"],"type":"object","properties":{"tagName":{"description":"Unique name of tag. Tag names are case-insensitive. Valid characters: `0`-`9`, `A`-`Z`, `a`-`z`, `_` (underscore), `-` (hyphen), and ' ' (blank space).  Maximum length is 35 characters.","maxLength":64,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"isActive":{"type":"boolean","description":"Status of the tag (active or inactive). Inactive tags cannot be applied to data entities."},"tagId":{"description":"ID of tag.","type":"integer","format":"int32","readOnly":true},"createdAt":{"type":"string","description":"Date created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"date-time","readOnly":true},"updatedAt":{"description":"Date updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date-time","readOnly":true},"createdBy":{"description":"Login of <<glossary:principal>> that created tag, 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":"employee@company.com","readOnly":true},"updatedBy":{"description":"Login of <<glossary:principal>> that updated tag, 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":"employee@company.com","readOnly":true}}},"EntityMap":{"required":["entityId","tagIds"],"type":"object","description":"List of mappings between tag entities and tags.","properties":{"entityId":{"description":"Tag entity by ID. One of `1` (Databases), `2` (Results), `3` (Profiles), `4` (Portfolios), `5` (Accounts), `6` (Treaties), `7` (Aggregate Portfolios), `8` (Programs), `9` (Business Hierachies)","type":"integer","format":"int32"},"tagIds":{"type":"array","description":"List of tags identifies by ID.","items":{"type":"integer","format":"int32"}}}},"TagGroup":{"required":["description","tagGroupName"],"type":"object","properties":{"tagGroupName":{"description":"Name of this tag group.","maxLength":64,"minLength":0,"pattern":"^\\w((?!--)[\\w\\s-])*\\w$|^\\w$","type":"string"},"tagGroupId":{"description":"ID of this tag group.","type":"integer","format":"int32","readOnly":true},"createdAt":{"type":"string","description":"Date created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","format":"date-time","readOnly":true},"updatedAt":{"description":"Date last updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","type":"string","format":"date-time","readOnly":true},"createdBy":{"description":"Login of <<glossary:principal>> that created tag group, 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":"employee@company.com","readOnly":true},"updatedBy":{"description":"Login of <<glossary:principal>> that updated tag group, 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":"employee@company.com","readOnly":true},"description":{"description":"Description of this tag group.","maxLength":1024,"minLength":0,"type":"string"},"entityMap":{"type":"array","description":"List of mappings between tag entities and tags.","items":{"$ref":"#/components/schemas/EntityMap"}},"isPrivate":{"type":"boolean"}}},"PredefinedCondition":{"required":["conditionType","predefinedConditionName"],"type":"object","properties":{"predefinedConditionId":{"type":"integer","format":"int32","description":"ID of predefined condition.","example":32,"readOnly":true},"predefinedConditionName":{"maxLength":40,"minLength":1,"description":"Name of predefined condition.","type":"string","example":"DTM-condition"},"limit":{"type":"number","format":"double","description":"Total amount of coverage provided by the condition. Is multiplied by the insurer’s pro-rata participation to determine their specific exposure. Total ground up limit of the sublimit special condition. Required if `conditionType` is `SUBLIMIT`.","example":1200000},"deductible":{"type":"number","format":"double","description":"Amount or percentage absorbed or paid by the insured before the policy takes effect. Depends on the `deductibleType`. Values <= 1 are interpreted as percentages; values > 1 are considered to be a flat amount.","example":2000000},"deductibleType":{"type":"string","description":"Type of deductible.","example":"DEFAULT","enum":["DEFAULT"]},"conditionType":{"type":"string","example":"POLICY_RESTRICTION","description":"Type of policy condition. Defines whether the condition restricts all policy coverage to just specific locations (`POLICY_RESTRICTION`) or whether a portion of the coverage is limited to a subset of locations (`SUBLIMIT`). If `SUBLIMIT`, `limit`, `deductibleType`, and `deductible` are required.","enum":["POLICY_RESTRICTION","SUBLIMIT"]},"percentOfLossDeductibleAmount":{"type":"number","format":"double","description":"Deductible expressed as a percentage of loss for given coverage or combination of coverages. As the loss increases, the deductible amount increases."},"isFranchiseDeductible":{"type":"string","description":"If `true`, <<glossary:franchise deductible>> is used. If `false`, <<glossary:conventional deductible>> is used.","enum":["YES","NO"]},"createdBy":{"type":"string","format":"email","example":"employee@company.com","description":"Login of <<glossary:principal>> that created predefined condition, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","readOnly":true},"createDate":{"type":"string","description":"Date created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","example":"2024-06-25T15:19:52.653Z","readOnly":true},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that updated predefined condition, 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},"updateDate":{"type":"string","example":"2024-06-25T15:19:52.653Z","description":"Date updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`","readOnly":true},"predefinedConditionCriterias":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PredefinedConditionCriteria"}},"uri":{"type":"string","example":"{{IRP_API_HOST}}/platform/referencedata/v1/predefinedconditions/24","readOnly":true}}},"PredefinedConditionCriteria":{"required":["field","operator","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of predefined condition criteria.","example":1,"readOnly":true},"logic":{"type":"string","example":"AND","description":"Logical operator in a compound query. One of `AND`, `OR`."},"openPar":{"type":"string","example":"(","description":"Opening parenthesis in compound query. One of `(`, `((`, `(((`."},"field":{"type":"string","example":"POSTALCODE","description":"Property to be searched by query."},"operator":{"type":"string","example":"=","description":"Comparison operator in query. One of `=`, `>`, `<` ,`>=`."},"value":{"type":"string","description":"Value of the `field` property.","example":94514},"closePar":{"type":"string","example":")","description":"Closing parenthesis in a compound query. One of `)`, `))`, `)))`."}}},"RollupDefaults":{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date","description":"endDate must be <=5 years from startDate"},"pricingConditions":{"type":"array","maxItems":50,"items":{"type":"object","properties":{"earliestInceptionDate":{"type":"string","format":"date"},"latestInceptionDate":{"type":"string","format":"date"},"earliestExpirationDate":{"type":"string","format":"date"},"latestExpirationDate":{"type":"string","format":"date"},"brokers":{"type":"array","items":{"type":"string"}},"offices":{"type":"array","items":{"type":"string"}},"businessUnits":{"type":"array","items":{"type":"string"}},"legalEntities":{"type":"array","items":{"type":"string"}},"quoteStatuses":{"type":"array","items":{"type":"string","enum":["New","Quote","Written","Signed","Canceled"]}},"corporateFormulaUuid":{"type":"string","format":"uuid"},"technicalFormulaUuid":{"type":"string","format":"uuid"}}}},"allowPricingConditionOverride":{"type":"boolean","default":false},"allowTechnicalPricingEdits":{"type":"boolean","default":false},"calculateCorporate":{"type":"boolean","default":false},"calculateTechnical":{"type":"boolean","default":false},"calculateOffered":{"type":"boolean","default":false},"createdAt":{"type":"string","format":"date-time","readOnly":true},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](principals).","example":"user.name@company.com","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> 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}}},"RollupMetadata":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of rollup metadata record.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"Name of rollup metadata record.","example":"customBrokerRecord"},"label":{"type":"string","description":"Label of rollup metadata record.","example":"Broker"},"metadataType":{"type":"string","description":"Type of rollup metadata record, e.g. `PROGRAM` (reinsurance program) or `TREATY` (<<glossary:program treaty>>).","enum":["PROGRAM","TREATY"],"example":"PROGRAM"},"inputType":{"type":"string","description":"Type of input.","enum":["LIST","STRING"],"example":"LIST"},"possibleValues":{"type":"array","description":"List of applicable values.","items":{"type":"string"},"example":["broker1","broker2","broker3"]}}},"RollupMetadataPatch":{"type":"object","properties":{"label":{"type":"string"},"inputType":{"type":"string","description":"Metadata input type.","enum":["LIST","STRING"]},"possibleValues":{"type":"array","items":{"type":"string"}}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"},"details":{"type":"array","nullable":true,"items":{"type":"object","properties":{"field":{"type":"string"},"messages":{"type":"array","nullable":true,"items":{"type":"string"}}}}}}},"PatchModelPricingFormula":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean","example":true}}},"ModelPricingFormula":{"type":"object","required":["uuid","name","riskMeasures","pricingFormula","capitalFormula","createdAt","createdBy","updatedAt","updatedBy"],"properties":{"uuid":{"type":"string","format":"uuid","readOnly":true,"example":"82bb8979-c759-4577-98dd-23dab2f5f0e0"},"name":{"type":"string"},"riskMeasures":{"type":"array","items":{"type":"object","required":["identifier","metricType","perspective","view","reported"],"properties":{"identifier":{"type":"string","example":"A"},"metricType":{"type":"string","enum":["Mean","STDev","AEP","OEP","TCE-AEP","TCE-OEP","Variance"],"example":"Mean"},"returnPeriod":{"type":"integer","description":"Return period for the metric, if applicable"},"perspective":{"type":"string","description":"Perspective for the risk measure","example":"GR"},"view":{"type":"string","enum":["Account"]},"reported":{"type":"boolean","description":"Whether the risk measure is reported","example":true}}}},"customRiskMeasures":{"type":"array","items":{"type":"object","required":["name","identifier","formula","reported"],"properties":{"name":{"type":"string"},"identifier":{"type":"string"},"formula":{"type":"string"},"reported":{"type":"boolean","description":"Whether the custom risk measure is reported","example":true}}}},"pricingFormula":{"type":"string","description":"Pricing formula.","example":"A + B"},"capitalFormula":{"type":"string","description":"Capital formula.","example":"C"},"isActive":{"type":"boolean","example":true},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Date and time the formula was created","example":"2025-07-03T01:44:42.606307Z"},"createdBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created the formula, 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},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"Date and time the formula was last updated","example":"2025-07-03T01:44:42.606307Z"},"updatedBy":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that last updated the formula, 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}}}},"securitySchemes":{"rms_bearer_token":{"type":"http","description":"RMS tenant specific bearer token to make authorized requests with temporary life span","scheme":"bearer","bearerFormat":"JWT"},"rms_api_key":{"type":"apiKey","name":"Authorization","description":"RMS tenant specific api key to make authorized requests","in":"header"}}}}