{"openapi":"3.0.2","info":{"title":"Import API","version":"2026.04.d"},"servers":[{"url":"https://{host}/platform/import/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":["csharp","curl","java","node","python"],"proxy-enabled":true,"samples-enabled":true},"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"paths":{"/folders":{"post":{"tags":["Import Folders"],"summary":"Create import folder","operationId":"createImportFolder","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MRIFolderRequest"},{"$ref":"#/components/schemas/EDMFolderRequest"},{"$ref":"#/components/schemas/OEDFolderRequest"},{"$ref":"#/components/schemas/CEDEFolderRequest"},{"$ref":"#/components/schemas/RDMFolderRequest"},{"$ref":"#/components/schemas/ExposureBulkEditFolderRequest"},{"$ref":"#/components/schemas/AccountVariationFolderRequest"},{"$ref":"#/components/schemas/PortfolioVariationFolderRequest"},{"$ref":"#/components/schemas/AggregatePortfolioVariationFolderRequest"},{"$ref":"#/components/schemas/RiskSourceFolderRequest"},{"$ref":"#/components/schemas/ALMFolderRequest"}],"discriminator":{"propertyName":"folderType","mapping":{"MRI":"#/components/schemas/MRIFolderRequest","EDM":"#/components/schemas/EDMFolderRequest","OED":"#/components/schemas/OEDFolderRequest","CEDE":"#/components/schemas/CEDEFolderRequest","RDM":"#/components/schemas/RDMFolderRequest","EXPOSURE_BULK_EDIT":"#/components/schemas/ExposureBulkEditFolderRequest","ACCOUNT_VARIATION":"#/components/schemas/AccountVariationFolderRequest","PORTFOLIO_VARIATION":"#/components/schemas/PortfolioVariationFolderRequest","AGGREGATE_PORTFOLIO_VARIATION":"#/components/schemas/AggregatePortfolioVariationFolderRequest","RISK_SOURCE":"#/components/schemas/RiskSourceFolderRequest","ALM":"#/components/schemas/ALMFolderRequest"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MRIFiles"},{"$ref":"#/components/schemas/EDMFiles"},{"$ref":"#/components/schemas/OEDFiles"},{"$ref":"#/components/schemas/CEDEFiles"},{"$ref":"#/components/schemas/RDMFiles"},{"$ref":"#/components/schemas/ExposureBulkEditFiles"},{"$ref":"#/components/schemas/AccountVariationFiles"},{"$ref":"#/components/schemas/PortfolioVariationFiles"},{"$ref":"#/components/schemas/AggregatePortfolioVariationFiles"},{"$ref":"#/components/schemas/RiskSourceFiles"},{"$ref":"#/components/schemas/ALMFiles"}],"discriminator":{"propertyName":"folderType","mapping":{"MRI":"#/components/schemas/MRIFiles","EDM":"#/components/schemas/EDMFiles","OED":"#/components/schemas/OEDFiles","CEDE":"#/components/schemas/CEDEFiles","RDM":"#/components/schemas/CEDEFiles","EXPOSURE_BULK_EDIT":"#/components/schemas/ExposureBulkEditFiles","ACCOUNT_VARIATION":"#/components/schemas/AccountVariationFiles","PORTFOLIO_VARIATION":"#/components/schemas/PortfolioVariationFiles","AGGREGATE_PORTFOLIO_VARIATION":"#/components/schemas/AggregatePortfolioVariationFiles","RISK_SOURCE":"#/components/schemas/RiskSourceFiles","ALM":"#/components/schemas/ALMFiles"}}}}}},"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"}}}}}}},"/jobs":{"post":{"tags":["Import Jobs"],"summary":"Create import job","operationId":"createImportJob","parameters":[{"name":"x-rms-resource-group-id","description":"ID of <<glossary:resource group>>. Operation is assigned to this resource group's quota. See [Resource Groups](doc:resource-management)","in":"header","required":true,"schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MRIImportRequest"},{"$ref":"#/components/schemas/EDMImportRequest"},{"$ref":"#/components/schemas/OEDImportRequest"},{"$ref":"#/components/schemas/CEDEImportRequest"},{"$ref":"#/components/schemas/RDMImportRequest"},{"$ref":"#/components/schemas/RDMDatabridgeImportRequest"},{"$ref":"#/components/schemas/ExposureBulkEditImportRequest"},{"$ref":"#/components/schemas/ExposureVariationImportRequest"},{"$ref":"#/components/schemas/ExposureResourceImportRequest"},{"$ref":"#/components/schemas/RiskSourceImportRequest"},{"$ref":"#/components/schemas/ALMImportRequest"}],"discriminator":{"propertyName":"importType","mapping":{"MRI":"#/components/schemas/MRIImportRequest","EDM":"#/components/schemas/EDMImportRequest","OED":"#/components/schemas/OEDImportRequest","CEDE":"#/components/schemas/CEDEImportRequest","RDM":"#/components/schemas/RDMImportRequest","RDM_DATABRIDGE":"#/components/schemas/RDMDatabridgeImportRequest","EXPOSURE_BULK_EDIT":"#/components/schemas/ExposureBulkEditImportRequest","EXPOSURE_VARIATION":"#/components/schemas/ExposureVariationImportRequest","EXPOSURE_RESOURCE":"#/components/schemas/ExposureResourceImportRequest","RISK_SOURCE":"#/components/schemas/RiskSourceImportRequest","ALM":"#/components/schemas/ALMImportRequest"}}}}}},"responses":{"201":{"description":"Created\n\nAdds `ALM_IMPORT`, `BULK_EDIT`, `CEDE_IMPORT`, `IMPORT`, `IMPORT_RDM`, `IMPORT_RISKSOURCE`, `MRI_IMPORT`, `OED_IMPORT`, `UPLOAD_EDM`, or `UPLOAD_RDM` job to queue and returns job URL with `jobId` in the `Location` header. Poll job URL for status.","headers":{"Location":{"description":"URI of `ALM_IMPORT`, `BULK_EDIT`, `CEDE_IMPORT`, `IMPORT`, `IMPORT_RDM`, `IMPORT_RISKSOURCE`, `MRI_IMPORT`, `OED_IMPORT`, `UPLOAD_EDM`, or `UPLOAD_RDM` job.","style":"simple","schema":{"type":"string","format":"uri","example":"https://api-use1.rms.com/platform/import/v1/jobs/112"}}}},"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"}}}}}},"get":{"tags":["Import Jobs"],"summary":"Search import jobs","operationId":"getImportJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. Supported properties: `endedAt`, `jobId`, `name`, `startedAt`, `status`, `type`, `userName` Depending on the property, you may use comparison operators, list operators, and logical operators.\n\n| Property| Data Type| Comparison| List| \n| :------ | :-------| :---------- | :--- | \n| `endedAt` | `YYY-MM-DD` | `=` | |\n| `jobId` | `string` | `=` | `IN` |\n| `name` | `string` | `=` |  |\n| `startedAt` | `YYY-MM-DD` | `=` | |\n| `status` | `string` | `=` |  |\n| `type` | `string` | `=` |  |\n| `userName` | `string` | `=` |  |\n            \nSee [Filtering Responses](doc:response-filtering).","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).\n\nSupported properties: `endedAt`, `jobId`, `name`, `startedAt`, `status`, `type`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records to display per page.","schema":{"type":"integer","format":"int32"}},{"name":"offSet","in":"query","description":"Number of the page displaying the returned records, starting at _0_.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSearchResult"}}}},"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"}}}}}}},"/jobs/{jobId}":{"get":{"tags":["Import Jobs"],"summary":"Get import job","operationId":"getImportJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"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":["Import Jobs"],"summary":"Update import job","operationId":"updateImportJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of import job","enum":["CANCELED"]},"priority":{"type":"string","description":"Priority of import job","enum":["high","medium","low","veryhigh","verylow"]}}}}}},"responses":{"202":{"description":"Accepted"},"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"}}}},"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"}}}}}}},"/folders/{folderId}/files/":{"get":{"tags":["Import Files"],"summary":"Get import files","operationId":"getImportFiles","parameters":[{"$ref":"#/components/parameters/FolderIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileSummary"}}}}},"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":["Import Files"],"summary":"Create import file","description":" ","operationId":"createImportFile","parameters":[{"$ref":"#/components/parameters/FolderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ALMFileRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ALMFileResponse"}}}},"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"}}}}}}},"/folders/{folderId}/files/{fileId}":{"get":{"tags":["Import Files"],"summary":"Get import file","operationId":"getImportFile","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/File"}}}},"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"}}}}}}},"/folders/{folderId}/files/{fileId}/transform":{"post":{"tags":["Import Files"],"summary":"Transform import file","operationId":"transformImportFile","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sheets":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number"}}}}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"import files":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","format":"int64"}}}}}}}}},"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"}}}}}}},"/folders/{folderId}/files/{fileId}/sample":{"get":{"tags":["Import Files"],"summary":"Get sample from import file","operationId":"getImportFileSample","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSourceFileResult"}}}},"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"}}}}}}},"/folders/{folderId}/files/{fileId}/mapping":{"get":{"tags":["Import Files"],"summary":"Get mapping from import file","operationId":"getImportFileMapping","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportMappingOutput"}}}},"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":["Import Files"],"summary":"Create mapping to import file","operationId":"createImportFileMapping","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportMappingInput"}}}},"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"}}}}}}},"/folders/{folderId}/files/{fileId}/retrieve-aggregate-exposures":{"post":{"tags":["Import Files"],"summary":"Retrieve aggregate exposures","description":" ","operationId":"retrieveAggregateExposures","parameters":[{"$ref":"#/components/parameters/FileIdParam"},{"$ref":"#/components/parameters/FolderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAggregateExposuresRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregateExposuresGrid"}}}},"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"}}}}}}},"/folders/{folderId}/update-aggregate-exposures":{"post":{"tags":["Import Folders"],"summary":"Update aggregate exposures","description":" ","operationId":"updateAggregateExposures","parameters":[{"$ref":"#/components/parameters/FolderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAggregateExposuresRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAggregateExposuresResponse"}}}},"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":{"parameters":{"FolderIdParam":{"name":"folderId","description":"ID of import folder","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},"AutoRunParam":{"name":"autorun","in":"query","description":"runs the job immediately if the settings are valid","schema":{"type":"boolean","default":true}},"JobIdParam":{"name":"jobId","in":"path","description":"ID of job.","schema":{"type":"string"},"required":true},"FileIdParam":{"name":"fileId","in":"path","description":"ID of import file","schema":{"type":"string"},"required":true}},"schemas":{"FileSummary":{"type":"object","properties":{"fileId":{"type":"string"},"status":{"type":"string","enum":["Ready","Not Ready"]},"sizeInMb":{"type":"string","format":"int64"},"createdAt":{"type":"string","format":"date-time","description":"Time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date time format.","example":"2020-08-07T00:00:00.000Z"},"modifiedAt":{"type":"string","format":"date-time","description":"Time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date time format.","example":"2020-08-07T00:00:00.000Z"},"name":{"type":"string"},"extension":{"type":"string"},"type":{"type":"string"}}},"File":{"type":"object","allOf":[{"$ref":"#/components/schemas/FileSummary"},{"type":"object","properties":{"sheets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"index":{"type":"number"}}}}}}]},"MRIImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job. MRI job imports resource data from MRI <<glossary:import folder>>.","enum":["MRI"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/MRISettings"}}}]},"EDMImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job. \n\n`EDM` jobs import exposure data uploaded to EDM <<glossary:import folder>>.","enum":["EDM"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/EDMSettings"}}}]},"OEDImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job. \n\n`OED` jobs imports OED data from OED <<glossary:import folder>>.","enum":["OED"]},"resourceUri":{"description":"<<glossary:Resource URI>> of <<glossary:exposure set>>.","example":"/platform/riskdata/v1/exposuresets/8888"}}},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/OEDSettings"}}}]},"CEDEImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job. \n\n`CEDE` jobs import CEDE from CEDE <<glossary:import folder>>.","enum":["CEDE"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/CEDESettings"}}}]},"RDMImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job. \n\n`RDM` job imports result data from RDM <<glossary:import folder>>.","enum":["RDM"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/RDMSettings"}}}]},"RDMDatabridgeImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\n`RDM_DATABRDIGE` jobs import result (`resourceUri`) from import folder into new RDM.","enum":["RDM_DATABRDIGE"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/RDMDatabridgeSettings"}}}]},"ExposureBulkEditImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\n`EXPOSURE_BULK_EDIT` jobs import exposure data from an <<glossary:import folder>> into an EDM.","enum":["EXPOSURE_BULK_EDIT"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ExposureBulkEditSettings"}}}]},"ExposureVariationImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\n`EXPOSURE_VARIATION` imports exposure variation data uploaded to <<glossary:import folder>>.","enum":["EXPOSURE_VARIATION"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ExposureVariationSettings"}}}]},"ExposureResourceImportRequest":{"allOf":[{"type":"object","required":["importType","resourceUri"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\n`EXPOSURE_RESOURCE` imports exposure resource data (one of Account or Portfolio or Aggregate Portfolio) from an existing exposure variation. Currently supports import into new EDM only.","enum":["EXPOSURE_RESOURCE"]}}},{"type":"object","properties":{"resourceUri":{"type":"string","description":"<<glossary:Resource URI>> of exposure set, e.g. `/platform/riskdata/v1/exposuresets/8613729`. \n\nData is imported into this exposure set. See [Resource URIs](doc:resource-uris)."}}},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ExposureResourceSettings"}}}]},"RiskSourceImportRequest":{"allOf":[{"type":"object","required":["importType","resourceUri"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\nImports ELT or PLT data as Risk Source into <<glossary:program>>.","enum":["RISK_SOURCE"]}}},{"type":"object","properties":{"resourceUri":{"type":"string","description":"<<glossary:Resource URI>> of program, e.g. `/platform/riskdata/v1/programs/432342`. \n\nRisk source is imported into this program. See [Resource URIs](doc:resource-uris)."}}},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/RiskSourceSettings"}}}]},"ALMImportRequest":{"allOf":[{"type":"object","required":["importType"],"properties":{"importType":{"type":"string","description":"Type of import job.\n\n`ALM` jobs import aggregate exposure data staged in an ALM <<glossary:import folder>> into aggregate portfolios on an EDM. The single `ALM` value covers both property and workers' compensation aggregate exposure data.","enum":["ALM"]}}},{"$ref":"#/components/schemas/RiskdataResourceRequestObject"},{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ALMSettings"}}}]},"MRIFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. \n\n`MRI` folders may be used for MRI import jobs only.","enum":["MRI"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/MRIFolderProperties"}}}]},"EDMFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"description":"Folder type determines the import job type.\n\n`EDM` folders may be used for EDM import jobs only.","type":"string","enum":["EDM"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/EDMFolderProperties"}}}]},"OEDFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. \n\n`OED` folders may be used for OED import jobs only.","enum":["OED"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/OEDFolderProperties"}}}]},"CEDEFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type.\n\n`CEDE` folders may be used for CEDE import jobs only.","enum":["CEDE"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/CEDEFolderProperties"}}}]},"RDMFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type\n\n`RDM` folders may be used for RDM import jobs only.","enum":["RDM"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/RDMFolderProperties"}}}]},"ExposureBulkEditFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type.\n\n`EXPOSURE_BULK_EDIT` folders may be used for Exposure Bulk Edit import jobs only.","enum":["EXPOSURE_BULK_EDIT"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/ExposureBulkEditFolderProperties"}}}]},"AccountVariationFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. `ACCOUNT_VARIATION` folders may be used for Account Variation (EXPOSURE_VARIATION) import jobs only.","enum":["ACCOUNT_VARIATION"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/AccountVariationFolderProperties"}}}]},"PortfolioVariationFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. `PORTFOLIO_VARIATION` folders may be used for Portfolio Variation (EXPOSURE_VARIATION) import jobs only.","enum":["PORTFOLIO_VARIATION"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/PortfolioVariationFolderProperties"}}}]},"AggregatePortfolioVariationFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. `AGGREGATE_PORTFOLIO_VARIATION` folders may be used for Aggregate Portfolio Variation (EXPOSURE_VARIATION) import jobs only.","enum":["AGGREGATE_PORTFOLIO_VARIATION"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/AggregatePortfolioVariationFolderProperties"}}}]},"RiskSourceFolderRequest":{"required":["folderType"],"allOf":[{"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. `RISK_SOURCE` folders may be used for Risk Source (RISK_SOURCE) import jobs only.","enum":["RISK_SOURCE"]}}},{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/RiskSourceFolderProperties"}}}]},"ALMFolderRequest":{"required":["folderType"],"type":"object","properties":{"folderType":{"type":"string","description":"Folder type determines the import job type. `ALM` folders may be used for ALM import jobs only. \n\nALM folder stages one or more <<glossary:flat file>>s of aggregate exposure data. Use Create Import File to allocate upload credentials.","enum":["ALM"]}}},"EDMSettings":{"type":"object","required":["folderId","serverId"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"exposureName":{"type":"string","description":"Name of EDM to create. Required if `preserveName` is `false` or undefined."},"preserveName":{"type":"boolean","default":false,"nullable":true,"description":"If `true`, EDM is imported using original name. If `false` or undefined, `exposureName` is required."},"serverId":{"type":"number","format":"int64"},"deferMetricCalculation":{"type":"boolean","default":false,"nullable":true},"tagIds":{"type":"array","items":{"type":"number","format":"int32"},"nullable":true}}},"EDMFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["EDM"]},"uploadDetails":{"description":"Information about the import folder.","properties":{"edmFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"OEDSettings":{"type":"object","properties":{"folderId":{"description":"ID of OED import folder.","$ref":"#/components/schemas/FolderId"},"exposureName":{"type":"string","description":"Name of new exposure (EDM).\n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters.","maxLength":80,"minLength":0,"pattern":"^$|^\\w((?!--)[\\w\\s-])*\\w$|^\\w$"},"geohaz":{"type":"boolean","description":"If `true`, geocodes and looks up hazard data for imported locations.","default":false},"currency":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that defines the default currency of EDM.","example":"USD"},"delimiter":{"type":"string","description":"Text delimiter used to separate columns of data in uploaded <<glossary:flat file>>.","enum":["COMMA","SEMICOLON","TAB"],"example":"TAB"},"portfolio":{"type":"object","description":"Imported data is added to the specified portfolio.","properties":{"portfolioName":{"description":"Name of portfolio.","maxLength":40,"minLength":0,"type":"string"},"portfolioNumber":{"description":"ID number of portfolio.","maxLength":20,"minLength":0,"type":"string"},"description":{"description":"Description of portfolio.","maxLength":255,"minLength":0,"type":"string"}}}}},"OEDFiles":{"type":"object","properties":{"folderType":{"type":"string","enum":["OED"]},"uploadDetails":{"description":"URLs and credentials needed to import files into import folder.","properties":{"locationsFile":{"description":"Resource URI, upload URL, and AWS credentials for `locationsFile`.","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"accountsFile":{"description":"Resource URI, upload URL, and AWS credentials for`accountsFile`","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"reinsuranceInfoFile":{"description":"Resource URI, upload URL, and AWS credentials for `reinsuranceInfoFile`","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"reinsuranceScopeFile":{"description":"Resource URI, upload URL, and AWS credentials for `reinsuranceScopeFile`","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"mappingsFile":{"description":"Resource URI, upload URL, and AWS credentials for `mappingsFile`","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"CEDESettings":{"type":"object","required":["folderId","exposureName","serverId","CEDESchemaVersion"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"exposureName":{"type":"string","description":"Name of new exposure (EDM).\n\nValid characters: `0`-`9`, `A`-`Z`, `a`-  `z`, underscore (`_`), hyphen (`-`), colon (`:`), and blank space. Cannot start or end with hyphen, space, or colon. Cannot include consecutive hyphens (`--`). Maximum length 80 characters.","maxLength":80,"minLength":0,"pattern":"^$|^\\w((?!--)[\\w\\s-])*\\w$|^\\w$"},"serverId":{"type":"number","description":"ID of server to host the new exposure (EDM)."},"cedeSchemaVersion":{"type":"string","description":"Version of CEDE Database Schema.","enum":["10.0"]}}},"CEDEFileTypes":{"type":"string","enum":["exposureFile","reinsuranceFile"]},"CEDEFiles":{"type":"object","properties":{"folderType":{"type":"string","enum":["CEDE"]},"uploadDetails":{"properties":{"exposureFile":{"$ref":"#/components/schemas/UploadDetails"},"reinsuranceFile":{"$ref":"#/components/schemas/UploadDetails"}}}}},"MRISettings":{"type":"object","properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"import files":{"type":"object","properties":{"accountsFileId":{"type":"string","description":"Name of account resource file.","example":"accountfile"},"locationsFileId":{"type":"string","description":"Name of location resource file.","example":"locationfile"},"reinsuranceFileId":{"type":"string","description":"Name of reinsurance resource file.","example":"reinsurancefile"},"mappingFileId":{"type":"string","description":"Name of mapping file.","example":"mappingfile"}}},"sheets":{"type":"object","properties":{"accountsSheetIndex":{"type":"number","description":"ID of account sheet."},"locationsSheetIndex":{"type":"number","description":"ID of location sheet."},"reinsuranceSheetIndex":{"type":"number","description":"ID of reinsurance sheet."}}},"currency":{"type":"string","description":"Default currency if the currency column is undefined or blank. Does not overwrite currency values in the source file themselves.","example":"USD"},"delimiter":{"type":"string","description":"Delimiter used to define columns of data in source files.","example":"SEMICOLON","enum":["COMMA","SEMICOLON","TAB"]},"skipLines":{"minimum":0,"type":"integer","format":"int32","description":"Number of rows to skip at beginning of source file if header columns are used.","example":0},"appendLocations":{"type":"boolean","description":"If `true`, imported location data are added to existing locations. If `false`, new locations replace existing locations.","example":true}}},"RDMSettings":{"type":"object","required":["folderId","rdmName"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"rdmName":{"type":"string","minLength":1,"maxLength":64}}},"RDMFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["RDM"]},"uploadDetails":{"properties":{"edmFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"ExposureBulkEditFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["EXPOSURE_BULK_EDIT"]},"uploadDetails":{"properties":{"exposureBulkEditFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"AccountVariationFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["ACCOUNT_VARIATION"]},"uploadDetails":{"properties":{"accountVariationFiles":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"PortfolioVariationFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["PORTFOLIO_VARIATION"]},"uploadDetails":{"properties":{"portfolioVariationFiles":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"AggregatePortfolioVariationFiles":{"type":"object","properties":{"importType":{"type":"string","enum":["AGGREGATE_PORTFOLIO_VARIATION"]},"uploadDetails":{"properties":{"aggregatePortfolioVariationFiles":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"RiskSourceFiles":{"type":"object","properties":{"folderType":{"type":"string","enum":["RISK_SOURCE"]},"folderId":{"type":"string"},"uploadDetails":{"properties":{"lossTableFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"ALMFiles":{"type":"object","properties":{"folderType":{"description":"Type of import folder.","type":"string","enum":["ALM"]},"folderId":{"type":"string","description":"ID of import folder.\n\nNo `uploadDetails` are returned for ALM import folders. Upload URLs and credentials are allocated per file using the Create Import File operation.","example":"43636"}}},"RDMDatabridgeSettings":{"type":"object","required":["rdmName","serverId"],"properties":{"rdmName":{"description":"Name of new RDM.","type":"string"},"serverId":{"description":"ID of <<glossary:managed server instance>> on Data Bridge.","type":"number","format":"int64"},"databaseId":{"description":"ID of database on the specified `serverId`.","type":"number","format":"int64"}}},"ExposureBulkEditSettings":{"type":"object","required":["folderId"],"properties":{"folderId":{"description":"ID of import folder.","type":"string","example":103773}}},"ExposureVariationSettings":{"type":"object","required":["folderId","exposureResourceId"],"properties":{"folderId":{"description":"ID of import folder.","type":"string","example":103773},"exposureResourceId":{"description":"ID of Exposure resource to link the variation to. one of accountId or portfolioId or aggregatePortfolioId.","type":"string","example":"456789"}}},"RiskSourceSettings":{"type":"object","required":["folderId","riskSourceName","riskSourceType","delimiter","modelUuid","currencyCode"],"properties":{"folderId":{"description":"ID of import folder.","type":"string","example":103773},"riskSourceName":{"type":"string","description":"Name of risk source to import.\n","minLength":1,"maxLength":255,"example":"My Risk Source"},"riskSourceDescription":{"type":"string","description":"Description of risk source.\n","nullable":true,"maxLength":1000,"example":"Risk source imported from external system"},"riskSourceType":{"type":"string","enum":["ELT","PLT"],"description":"Type of risk source.","example":"ELT"},"delimiter":{"type":"string","enum":["COMMA","SEMICOLON","TAB"],"description":"Text delimiter used to separate columns in uploaded <<glossary:flat file>>.","example":"TAB"},"jobname":{"type":"string","description":"Name of import job.","nullable":true,"maxLength":255,"example":"Test Job Name"},"modelUuid":{"type":"string","format":"uuid","description":"UUID of model associated with imported risk source.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$","example":"550e8400-e29b-41d4-a716-446655440000"},"currencyCode":{"type":"string","description":"Three-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) country code that identifies the default currency of risk source data. For example, _USD_.","pattern":"^[A-Z]{3}$","minLength":3,"maxLength":3,"example":"USD"},"startDate":{"type":"string","format":"date","description":"Start date of PLT catalog period in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) calendar date format.","example":"2025-01-01"},"endDate":{"type":"string","format":"date","description":"End date of PLT catalog period in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) calendar date format.","example":"2025-12-31"},"numberOfYears":{"type":"integer","format":"int32","description":"Number of simulation years for PLT risk source.","example":1},"numberOfPeriods":{"type":"integer","format":"int32","description":"Number of simulation periods for PLT risk source.","example":100}}},"ExposureResourceSettings":{"type":"object","required":["exposureName","exposureVariationId"],"properties":{"exposureName":{"description":"Name of new Exposure resource to be created. one of accountName or portfolioName or aggregatePortfolioName.","type":"string"},"exposureVariationId":{"description":"ID of Exposure Variation to import the data from.","type":"integer","format":"int64","example":456789}}},"ALMSettings":{"type":"object","required":["folderId","portfolioIds"],"properties":{"folderId":{"$ref":"#/components/schemas/FolderId"},"portfolioIds":{"type":"array","description":"IDs of aggregate portfolios on the EDM referenced by `resourceUri`. The job writes the imported aggregate exposure data into these aggregate portfolios.\n\nThe job processes every file in the import folder that has an aggregate exposures list saved by the Update aggregate exposures operation. Workers' compensation aggregate exposure data is imported into aggregate portfolios whose `source` is `Work Comp`.","items":{"type":"integer","format":"int32"},"example":[123,235]}}},"EDMFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"description":"Type of import file.","type":"string","enum":["bak","mdf"]},"fileTypes":{"type":"array","description":"List of files to import.","items":{"$ref":"#/components/schemas/EDMFileTypes"},"uniqueItems":true}}},"OEDFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"description":"File type of import file.\n\nImport folder accepts `accountsFile`, `locationsFile`, `reinsuranceInfoFile`, and `reinsuranceScopeFile` in the specified file format (CSV or TXT). \n\n`mappingsFile` is always in MFF file format.","type":"string","enum":["csv","txt"]},"fileTypes":{"type":"array","description":"List of file types to import.\n\nSupports five file types: `accountsFile`, `locationsFile`, `mappingsFile`, `reinsuranceInfoFile`, and `reinsuranceScopeFile`. \n\n- If omitted, response returns upload credentials for all five file types.\n- If included, request must specify both `accountsFile` and `locationsFile`. `reinsuranceInfoFile`, and `reinsuranceScopeFile` are mutually inclusive. If one is specified, the other must be specified as well.","items":{"$ref":"#/components/schemas/OEDFileTypes"},"uniqueItems":true}}},"CEDEFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileTypes":{"type":"array","items":{"$ref":"#/components/schemas/CEDEFileTypes"}},"fileExtension":{"type":"string","description":"Type of import file.","enum":["bak","mdf"]}}},"MRIFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"description":"Type of import file.","type":"string","enum":["xlsx","csv","txt"]},"fileTypes":{"type":"array","description":"List of files to import.","items":{"$ref":"#/components/schemas/MRIFileTypes"},"uniqueItems":true}}},"RDMFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"type":"string","description":"Type of import file.","enum":["bak","mdf"]},"fileTypes":{"type":"array","description":"List of files to import.","items":{"$ref":"#/components/schemas/RDMFileTypes"},"uniqueItems":true}}},"ExposureBulkEditFolderProperties":{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"description":"Type of import file.","type":"string","enum":["json","gz"]},"fileTypes":{"type":"array","description":"List of files to import.","items":{"$ref":"#/components/schemas/ExposureBulkEditFileTypes"},"uniqueItems":true}}},"AccountVariationFolderProperties":{"type":"object","required":["fileExtension","fileTypes"],"properties":{"fileExtension":{"type":"string","enum":["parquet"]},"fileTypes":{"type":"array","description":"List the files relevant to the import","items":{"$ref":"#/components/schemas/AccountVariationFileTypes"},"uniqueItems":true}}},"PortfolioVariationFolderProperties":{"type":"object","required":["fileExtension","fileTypes"],"properties":{"fileExtension":{"type":"string","enum":["parquet"]},"fileTypes":{"type":"array","description":"List the files relevant to the import","items":{"$ref":"#/components/schemas/PortfolioVariationFileTypes"},"uniqueItems":true}}},"AggregatePortfolioVariationFolderProperties":{"type":"object","required":["fileExtension","fileTypes"],"properties":{"fileExtension":{"type":"string","enum":["parquet"]},"fileTypes":{"type":"array","description":"List the files relevant to the import","items":{"$ref":"#/components/schemas/AggregatePortfolioVariationFileTypes"},"uniqueItems":true}}},"RiskSourceFolderProperties":{"type":"object","required":["fileExtension","fileTypes"],"properties":{"fileExtension":{"type":"string","enum":["csv"]},"fileTypes":{"type":"array","description":"List the files relevant to the import","items":{"$ref":"#/components/schemas/RiskSourceFileTypes"},"uniqueItems":true}}},"MRIFileTypes":{"type":"string","enum":["spreadsheet","accountsFile","locationsFile","reinsuranceFile","mappingFile"]},"EDMFileTypes":{"type":"string","enum":["exposureFile"]},"OEDFileTypes":{"type":"string","enum":["accountsFile","locationsFile","mappingsFile","reinsuranceInfoFile","reinsuranceScopeFile"]},"MRIFiles":{"type":"object","properties":{"folderType":{"type":"string","enum":["MRI"]},"folderId":{"type":"string"},"uploadDetails":{"properties":{"spreadsheet":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"accountsFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"locationsFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"reinsuranceFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]},"mappingFile":{"allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}}}},"RDMFileTypes":{"type":"string","enum":["resultsFile"]},"ExposureBulkEditFileTypes":{"type":"string","enum":["exposureBulkEditFile"]},"AccountVariationFileTypes":{"type":"string","enum":["accountVariationFiles"]},"PortfolioVariationFileTypes":{"type":"string","enum":["portfolioVariationFiles"]},"AggregatePortfolioVariationFileTypes":{"type":"string","enum":["aggregatePortfolioVariationFiles"]},"RiskSourceFileTypes":{"type":"string","enum":["lossTableFile"]},"FolderId":{"type":"string","format":"int64","description":"ID of import folder."},"RiskdataResourceRequestObject":{"type":"object","required":["resourceUri"],"properties":{"resourceUri":{"description":"<<glossary:Resource URI>> of EDM, e.g. `/platform/riskdata/v1/exposures/8613729` \n\nData is imported into this EDM. See [Resource URIs](doc:resource-uris).","$ref":"#/components/schemas/RiskdataResource"}}},"RiskdataResource":{"type":"string","format":"uri","example":"/platform/riskdata/v1/exposures/8613739"},"UploadDetails":{"type":"object","properties":{"uploadUrl":{"description":"URL of import folder in the tenant's Amazon S3 bucket. \n\nURL includes system-defined name of file. Uploaded file must use the specified file name. File type depends on `fileType` parameter specified in request. Mapping files are in MFF file format.","type":"string","format":"url","example":"https://rms-tenants-xxx.s3.amazonaws.com/xxx/import/platform/exposure_bulk_edit/xxx/xxx-exposurebulkeditfile.json"},"fileUri":{"type":"string","description":"<<glossary:Resource URI>> of file.","format":"uri","example":"platform/import/v1/folders/123213/files/1"},"presignParams":{"type":"object","description":"Credentials needed to upload file to import folder on Amazon S3. The `accessKey`, `secretKey`, and `sessionToken` enable client to sign AWS request.","properties":{"accessKeyId":{"type":"string","example":"QVNJQTNDTlNBUlFPVVo0NVo0QzI=","description":"Base64-encoded access key returned by AWS Security Token Service."},"secretAccessKey":{"type":"string","example":"aTZjcWc3eW1ZSmpZN2tLaHJMcUNzL0FYT2UweWE4NmUwMVgwWkZ4=","description":"Base64-encoded access key returned by AWS Security Token Service."},"sessionToken":{"type":"string","description":"Base64-encoded access key returned by AWS Security Token Service.","example":"RndvR1pYSXZZWGR6RUNJYURCQUNYOENncTN5bmVVRE5LQ0tCWkZ4w"},"path":{"type":"string","description":"Base64-encoded path returned by AWS Security Token Service.","example":"cm1zLXRlbmFudHMtbnBlLWV1LXdlc3QtMS8yMDAxNjY3L2ltcG9yA"},"region":{"type":"string","description":"Base64-encoded region of AWS.","example":"ZXUtd2VzdC0x"}}}}},"ALMFileRequest":{"type":"object","required":["fileName","fileType","fileInputType"],"properties":{"fileName":{"type":"string","description":"Name of file to upload, including the `.csv` or `.txt` file extension.","example":"alm-property-county.txt"},"fileType":{"type":"string","description":"Type of import file.","enum":["aggregate-exposure-data"]},"fileInputType":{"type":"string","description":"Type of import file input. Must match the `folderType` of the import folder.","enum":["ALM"]}}},"ALMFileResponse":{"type":"object","properties":{"fileId":{"type":"string","description":"ID of import file.","example":"541039"},"uploadDetails":{"description":"URL and credentials needed to upload the file to the import folder. Decode each Base64-encoded value of `presignParams` and use the decoded credentials to upload the file to `uploadUrl` with an HTTP PUT request.","allOf":[{"$ref":"#/components/schemas/UploadDetails"}]}}},"RetrieveAggregateExposuresRequest":{"type":"object","required":["insuranceType","delimiter","dataRowStart","countryCode","resolution","columnMapping"],"properties":{"insuranceType":{"type":"string","description":"Insurance type of exposure data in uploaded flat file.","enum":["PROPERTY","WORKERS_COMP"]},"delimiter":{"type":"string","description":"Text delimiter used to separate columns of data in the uploaded <<glossary:flat file>>.","enum":["Tab","Comma","Semicolon","Pipe"]},"dataRowStart":{"type":"integer","format":"int32","minimum":1,"description":"Row number of the first row of aggregate exposure data. Use to ignore header rows.","example":2},"countryCode":{"type":"string","description":"Two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) code of the country uploaded exposure data. `WORKERS_COMP` data supports `US` only.","example":"US"},"resolution":{"type":"string","description":"Geographic granularity used to aggregate the uploaded exposure data, For example, `State`, `County`, or `Postal Code`. Child of the specified `dependencyResolution`. For example, _County_ is the child of _State_.\n\nThe geographic granularity at which exposure data is aggregated. Identifies the geographic unit (e.g. State, County, Postal Code, CRESTA) into which the file's rows are summed, and those units become the `resolutionValues` rows of the returned grid.","example":"County"},"dependencyResolution":{"type":"string","nullable":true,"description":"Parent resolution of the specified `resolution` value. For example, _State_ is the parent of _County_. Required for nested resolutions. Top-level resolutions (e.g. State, CRESTA, or Province) have not parent.","example":"State"},"resolutionConversionFrom":{"type":"string","description":"Resolution of the source data. \n\nTo aggregate the data into a coarser resolution, specify the file's resolution in `resolutionConversionFrom` and the target resolution in `resolutionConversionTo`.","example":"County"},"resolutionConversionTo":{"type":"string","description":"Resolution of aggregate exposure grid.","example":"County"},"columnMapping":{"type":"object","description":"Map of destination fields to source column numbers in the file.\n\nFor property data, map the geography fields plus one field per line of business. For workers' compensation data, map `State`, `Occ Scheme`, `Occ Type`, and `Payroll`, plus `County` or `Postal Code` when required by the resolution.","additionalProperties":{"type":"string"},"example":{"State":"1","County":"2","AUTOMOBILE":"3","COMMERCIAL":"4","MOBILE HOME":"5","RESIDENTIAL":"6"}}}},"AggregateExposuresGrid":{"type":"object","properties":{"insuranceType":{"type":"string","description":"Insurance type of uploaded aggregate exposure data. Required to parse data in flat file.","enum":["PROPERTY","WORKERS_COMP"]},"countryCode":{"type":"string","description":"Two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) code of the country of aggregate exposure data. `WORKERS_COMP` data supports `US` only.","example":"US"},"resolution":{"type":"string","description":"Geographic granularity of aggregated data in <<glossary:aggregate exposure grid>>. Child of the specified `dependencyResolution`. For example, _County_ is the child of _State_.","example":"County"},"dependencyResolution":{"type":"string","nullable":true,"description":"Parent resolution of the specified `resolution` value. For example, _State_ is the parent of _County_. Required for nested resolutions. Top-level resolutions (e.g. State, CRESTA, or Province) have not parent.","example":"State"},"resolutionConversionFrom":{"type":"string","description":"Resolution of aggregate exposure data in the uploaded file.","example":"County"},"resolutionConversionTo":{"type":"string","description":"Resolution of aggregate exposure data in the <glossary:aggregate exposure grid>>.","example":"County"},"columnMapping":{"type":"object","description":"Map of destination fields to source column numbers, echoed from the request.\n\n- If `PROPERTY` data, map the `State` and `County`, plus one field per line of business.A\n- If `WORKERS_COMP` data, map `State`, `Occ Scheme`, `Occ Type`, and `Payroll`, plus `County` or `Postal Code`.","additionalProperties":{"type":"integer"}},"lobs":{"type":"array","description":"Ordered list of line of business column headers.\n\nFor property data, the lines of business mapped from the file. For workers' compensation data, the fixed list of workers' compensation classes; each row's `Occ Scheme` and `Occ Type` values are mapped to one class and the row's `Payroll` is summed into that column.","items":{"type":"string"}},"resolutionValues":{"type":"array","description":"Ordered list of row labels. Rows cover every resolution bucket of the country and resolution.","items":{"$ref":"#/components/schemas/AggregateExposuresResolutionValue"}},"values":{"type":"array","description":"Grid of aggregate exposure values. Rows are ordered by `resolutionValues` and columns are ordered by `lobs`; every row carries the full column width.\n\nMultiple file rows that map to the same resolution bucket are summed. Resolution buckets without data in the file are zero-filled.","items":{"type":"array","items":{"type":"number","format":"double"}}},"errorMessages":{"type":"array","description":"List of parsing errors.","items":{"type":"object","properties":{"row":{"type":"string"},"column":{"type":"string"},"text":{"type":"string"}}}}}},"AggregateExposuresResolutionValue":{"type":"object","properties":{"code":{"type":"string","description":"Code of resolution bucket, for example a state or county code.","example":"001"},"name":{"type":"string","description":"Name of resolution bucket.","example":"BELKNAP COUNTY"},"id":{"type":"string","description":"ID of the parent resolution bucket, for example the state of a county or the country of a state.","example":"NH"},"statecode":{"type":"string","description":"Numeric code of state. Returned for state-level rows.","example":"02"}}},"UpdateAggregateExposuresRequest":{"type":"object","required":["insuranceType","countryCode","resolution","lobs","resolutionValues","values"],"properties":{"insuranceType":{"type":"string","description":"Insurance type of uploaded aggregate exposure data. Required to parse data in flat file.","enum":["PROPERTY","WORKERS_COMP"]},"countryCode":{"type":"string","description":"Two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) code of the country of aggregate exposure data. \n\nMust match the country specified in the retrieved <<glossary:aggregate exposure grid>>.","example":"US"},"resolution":{"type":"string","description":"Geographic granularity aggregate data in the aggregate exposure grid. Must match the resolution of the retrieved grid.","example":"County"},"dependencyResolution":{"type":"string","description":"Parent resolution of the specified `resolution` value. For example, _State_ is the parent of _County_.","nullable":true,"example":"State"},"resolutionConversionFrom":{"type":"string","description":"Source resolution of the uploaded data before conversion.","example":"County"},"resolutionConversionTo":{"type":"string","description":"Target resolution of the converted aggregate data.","example":"County"},"columnMapping":{"type":"object","description":"Map of source column position to destination property in the form `{\"destinationField\": \"sourceColumn}`","additionalProperties":{"type":"integer"}},"lobs":{"type":"array","description":"Ordered list of line of business column headers. Must match the line of business set for the country and insurance type.","items":{"type":"string"}},"resolutionValues":{"type":"array","description":"Ordered list of row labels. One entry per row of `values`; every `code` must be valid for the country and resolution.","items":{"$ref":"#/components/schemas/AggregateExposuresResolutionValue"}},"values":{"type":"array","description":"Grid of aggregate exposure values to save. The number of rows must match the length of `resolutionValues` and the width of every row must match the length of `lobs`. Values must be zero or greater; all-zero rows are valid and are persisted.","items":{"type":"array","items":{"type":"number","format":"double"}}}}},"UpdateAggregateExposuresResponse":{"type":"object","properties":{"countryCode":{"type":"string","example":"US"},"resolution":{"type":"string","example":"County"},"rowsPersisted":{"type":"integer","format":"int32","description":"Number of resolution rows saved, including all-zero rows.","example":3}}},"JobSearchResult":{"type":"array","items":{"$ref":"#/components/schemas/JobSummary"}},"Task":{"type":"object","properties":{"taskId":{"type":"string","format":"int32","description":"ID of <<glossary:task>>."},"guid":{"type":"string","format":"uuid","description":"Unique ID of task."},"jobId":{"type":"string","format":"int64","description":"ID of <<glossary:batch job>>."},"status":{"type":"string","description":"Status of task. One of `PENDING`, `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `CANCEL_REQUESTED`, `CANCELLING`, `CANCELLED`."},"submittedAt":{"type":"string","format":"date-time","description":"Time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date time format.","example":"2020-08-07T00:00:00.000Z"},"createdAt":{"type":"string","format":"date-time","description":"Time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date time format.","example":"2020-08-07T00:00:00.000Z"},"name":{"type":"string","description":"Name of task."},"percentComplete":{"type":"integer","format":"int32","description":"Percent of task completion."},"priorTaskGuids":{"type":"array","description":"List of tasks in batch job.","items":{"type":"string","format":"uuid"}},"output":{"type":"object","description":"List of error messages and logs.","properties":{"summary":{"type":"string"},"errors":{"type":"array","description":"List of error messages.","items":{"type":"object","properties":{"message":{"type":"string"}}}},"log":{"type":"object","description":"Log of task processing."}}}}},"JobSummary":{"type":"object","properties":{"jobId":{"type":"string","format":"int64","description":"ID of job."},"priority":{"type":"string","description":"Priority of job.","enum":["verylow","low","medium","high","veryhigh"]},"userName":{"type":"string","format":"email","description":"Name of API key or login of <<glossary:principal>> that submitted job, e.g. `user.name@company.com` or `SSO_user.name@company` for <<glossary:federated tenant>>s. Login strings are lowercase. See [Logins](doc:principals).","example":"user.name@company.com"},"status":{"type":"string","description":"Status of job.","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string","description":"Time job was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"startedAt":{"type":"string","description":"Time job was started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"endedAt":{"type":"string","description":"Time job was completed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`."},"name":{"type":"string","description":"Name of job."},"type":{"type":"string","description":"Type of job. See [Platform Job](doc:platform-jobs)."},"progress":{"type":"integer","format":"int32","description":"Percent of job completion."},"resourceGroupId":{"type":"string","format":"uuid","description":"ID of <<glossary:resource group>> that submitted job. See [Resource Groups](doc:resource-management)."},"entitlement":{"type":"string","description":"Licensed Intelligent Risk Platform program. One of `RI-EXPOSUREIQ`, RI-RISKMODELER, `RI-TREATYIQ`, `RI-UNDERWRITEIQ`."},"details":{"type":"object","description":"Detailed information about job and child tasks.","properties":{"resources":{"type":"array","description":"List of <<glossary:resource URIs>>.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}},"summary":{"type":"string"}}}}},"Job":{"type":"object","allOf":[{"$ref":"#/components/schemas/JobSummary"},{"type":"object","properties":{"tasks":{"type":"array","description":"List of task objects. A batch job consits of multiple child tasks.","items":{"$ref":"#/components/schemas/Task"}}}}]},"ImportSourceFileResult":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ImportSourceFileItem"}}}},"ImportMappingOutput":{"required":["accountItems","locationItems","reinsuranceItems"],"type":"object","properties":{"accountItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}},"locationItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}},"reinsuranceItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}}}},"ImportMappingInput":{"required":["accountItems","locationItems","mapFileName"],"type":"object","properties":{"mapFileName":{"type":"string"},"accountItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}},"locationItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}},"reinsuranceItems":{"type":"array","items":{"$ref":"#/components/schemas/ImportMappingItem"}}}},"ImportSourceFileItem":{"type":"object","properties":{"source":{"type":"string"},"sourceExample":{"type":"string"}}},"ImportMappingItem":{"type":"object","properties":{"source":{"type":"string"},"destination":{"type":"string"}}},"ErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"logId":{"type":"string"}}}},"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"}}}}