{"openapi":"3.0.1","info":{"title":"Export API","version":"2026.03.b"},"servers":[{"url":"https://{host}/platform/export/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"}}}],"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["json","curl","python","java","csharp","node"],"proxy-enabled":true,"samples-enabled":true},"paths":{"/jobs/":{"post":{"tags":["Export Jobs"],"summary":"Create export job","operationId":"createExportJob","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/ExposureResourceRequest"},{"$ref":"#/components/schemas/EDMRequest"},{"$ref":"#/components/schemas/RDMRequest"},{"$ref":"#/components/schemas/RDMDatabridgeRequest"},{"$ref":"#/components/schemas/ResultsRequest"},{"$ref":"#/components/schemas/LocationResultsRequest"},{"$ref":"#/components/schemas/RollupResultsRequest"},{"$ref":"#/components/schemas/ExposureVariationRequest"}],"discriminator":{"propertyName":"exportType","mapping":{"EXPOSURE_RESOURCE":"#/components/schemas/ExposureResourceRequest","EDM":"#/components/schemas/EDMRequest","RDM":"#/components/schemas/RDMRequest","RDM_DATABRIDGE":"#/components/schemas/RDMDatabridgeRequest","RESULTS":"#/components/schemas/ResultsRequest","LOCATION_RESULTS":"#/components/schemas/LocationResultsRequest","ROLLUP_RESULTS":"#/components/schemas/RollupResultsRequest","EXPOSURE_VARIATION":"#/components/schemas/ExposureVariationRequest"}}}}}},"responses":{"201":{"description":"Created.\n\nInitiates an export job. Job type depends on the `exportType` specified in the request.","headers":{"Location":{"description":"URI of export job. Job type depends on the `exportType` specified in the request. One of `DOWNLOAD_EDM`, `DOWNLOAD_EXPOSURE_RESOURCE`, `DOWNLOAD_LOCATION_RESULTS`, `DOWNLOAD_RDM`, `DOWNLOAD_RESULTS`, `DOWNLOAD_ROLLUP_RESULTS`.\n\nThe `Location` header returns a job URL that can be used to poll the status of the export job. See [Get Export Job](ref:getexportjob).","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"}}}}}},"get":{"tags":["Export Jobs"],"summary":"Search export jobs","operationId":"getExportJobs","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":["Export Jobs"],"summary":"Get export job","operationId":"getExportJob","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":["Export Jobs"],"summary":"Update export job","operationId":"updateExportJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"requestBody":{"description":"Operations to perform on export job","required":true,"content":{"application/json":{"schema":{"type":"object","oneOf":[{"properties":{"status":{"description":"Status of export job","type":"string","enum":["CANCELLED"]}}},{"properties":{"priority":{"type":"string","description":"Priority of export 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"}}}}}}},"/tasks":{"post":{"tags":["Export Tasks"],"summary":"Create export task","operationId":"createExportTask","description":" ","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EstimateRDMSizePlatformRequest"},{"$ref":"#/components/schemas/EstimateRDMSizeDatabridgeRequest"}],"discriminator":{"propertyName":"exportType","mapping":{"RDM":"#/components/schemas/EstimateRDMSizePlatformRequest","RDM_DATABRIDGE":"#/components/schemas/EstimateRDMSizeDatabridgeRequest"}}}}}},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"URI of the task. Use this URL to poll task status and retrieve the result (e.g. size estimate).","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"}}}}}}},"/tasks/{taskUUID}":{"get":{"tags":["Export Tasks"],"summary":"Get export task","operationId":"getExportTask","description":" ","parameters":[{"$ref":"#/components/parameters/TaskUUIDParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportTask"}}}},"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":{"ExportTypeParam":{"name":"exporttype","in":"query","schema":{"$ref":"#/components/schemas/ExportInput"}},"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 export job.","schema":{"type":"string"},"required":true},"TaskUUIDParam":{"name":"taskUUID","in":"path","description":"UUID of the export task.","schema":{"type":"string","format":"uuid"},"required":true}},"schemas":{"Task":{"type":"object","properties":{"taskId":{"type":"string","description":"ID of <<glossary:task>>.","format":"int32"},"guid":{"type":"string","description":"Unique ID of task.","format":"uuid"},"jobId":{"type":"string","description":"ID of <<glossary:batch job>>.","format":"int64","example":67},"status":{"type":"string","description":"Status of job. One of `PENDING`, `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `CANCEL_REQUESTED`, `CANCELLING`, `CANCELLED`."},"submittedAt":{"type":"string","description":"Time task was submitted in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`"},"createdAt":{"type":"string","description":"Time task was created 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 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."}}}}},"EstimateRDMSizePlatformRequest":{"type":"object","description":"Request to estimate RDM size for a Platform export (DP-12829). Task type `RDM_ESTIMATE`.","required":["taskType","exportType","resourceUris","exportLossFormat"],"properties":{"taskType":{"type":"string","enum":["RDM_ESTIMATE"],"description":"Type of task."},"exportType":{"type":"string","enum":["RDM"]},"resourceUris":{"type":"array","description":"List of analysis URIs to estimate. See [Resource URIs](doc:resource-uris).","items":{"type":"string","format":"uri"},"minItems":1,"example":"/platform/riskdata/v1/analyses/183322"},"exportLossFormat":{"type":"string","enum":["PLT","ELT"],"description":"Loss table format for the estimate."}}},"EstimateRDMSizeDatabridgeRequest":{"type":"object","description":"Request to estimate RDM size for a Databridge export (DP-12829). Task type `RDM_ESTIMATE`.\nUse `settings.serverId` only for a new RDM; add `settings.databaseId` for an existing hosted RDM.","required":["taskType","exportType","resourceUris","settings"],"properties":{"taskType":{"type":"string","enum":["RDM_ESTIMATE"],"description":"Type of task."},"exportType":{"type":"string","enum":["RDM_DATABRIDGE"]},"resourceUris":{"type":"array","description":"List of analysis URIs to estimate. See [Resource URIs](doc:resource-uris).","items":{"type":"string","format":"uri"},"minItems":1,"example":"/platform/riskdata/v1/analyses/183322"},"settings":{"type":"object","required":["serverId"],"properties":{"serverId":{"type":"integer","format":"int64","description":"ID of <<glossary:managed server instance>> on Data Bridge."},"databaseId":{"type":"integer","format":"int64","description":"Optional. ID of <<glossary:hosted database>> when estimating for an existing RDM."}}}}},"ExportTask":{"type":"object","description":"Short-lived export task (e.g. RDM size estimator). Identified by task UUID; poll until complete then read result.","properties":{"taskUuid":{"type":"string","format":"uuid","description":"UUID of export task."},"taskType":{"type":"string","description":"Type of export task, e.g. `RDM_ESTIMATE`."},"taskName":{"type":"string","description":"Name of export task."},"status":{"type":"string","description":"Status of export task. One of `CANCELLED`. `COMPLETED`, `FAILED`, `PENDING`, `QUEUED`, `RUNNING`."},"createdAt":{"type":"string","format":"date-time","description":"Time export task was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"updatedAt":{"type":"string","format":"date-time","description":"Time export task was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."},"expiresAt":{"type":"string","format":"date-time","description":"Time that export task expires in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task response can no be retrieved after this time."},"createdBy":{"type":"string","description":"Email or API key of <<glossary:principal>> that created export task."},"output":{"$ref":"#/components/schemas/ExportTaskOutput"}}},"ExportTaskOutput":{"type":"object","description":"Output for export task. Output depends on export task type.","properties":{"errors":{"type":"array","description":"List of error messages.  Successful export tasks return empty array.","items":{"type":"object"}},"log":{"type":"object","description":"Export task-specific output for `COMPLETED` export task. Task-specific log data. `RDM_ESTIMATE` export tasks return `rdmEstimate`.","properties":{"rdmEstimate":{"$ref":"#/components/schemas/RDMSizeEstimateResult"}}}}},"RDMSizeEstimateResult":{"type":"object","description":"Estimate of size of `RDM` or `RDM_DATABRIDGE` export job.","properties":{"mdfEstimateSize":{"type":"string","description":"Estimated size of MDF file.","example":"151 MB"},"estimatedSizeBytes":{"type":"integer","format":"int64","description":"Estimated size in bytes.","example":130701634},"numberOfAnalyses":{"type":"integer","description":"Number of analysis results exported."},"analyses":{"type":"object","properties":{"rlAnalyses":{"description":"List of DLM analysis result IDs.","type":"array","items":{"type":"string"}},"hdAnalyses":{"description":"List of HD analysis result IDs.","type":"array","items":{"type":"string"}},"acAnalyses":{"description":"List of ALM analysis result IDs.","type":"array","items":{"type":"string"}}}},"totalTables":{"type":"integer","description":"Number of database tables exported."},"totalFiles":{"type":"integer","description":"Number of files exported. May be omitted."},"topTablesBreakdown":{"description":"Comma-separated list of table names and sizes.","type":"string","example":"rdm_port_0_1_32263.parquet:61 MB, rdm_anlsevent_0_1_32361.parquet:7 MB, rdm_metadata:78 KB"},"totalProcessingTimeSeconds":{"type":"integer","description":"Time to estimate size of exported data in seconds.","example":2},"validationStatus":{"type":"string","description":"Status of estimation job.","example":"SUCCESS"},"validationWarnings":{"description":"List of warning messages.","type":"array","items":{"type":"string"}},"validationError":{"description":"List of warning messages.","type":"string","nullable":true},"diskUsagePercentage":{"description":"Percentage of Data Bridge disk space used by exported losses.","type":"number","example":0},"currentAvailableSpaceBytes":{"description":"Size of Data Bridge disk space available in bytes.","type":"integer","format":"int64","example":2319063557822},"currentAvailableSpaceSize":{"description":"Size of Data Bridge disk space available in TB.","type":"string","example":"2 TB"},"availableSpaceAfterExportBytes":{"description":"Size of Data Bridge disk space in bytes available after export.","type":"integer","format":"int64","example":2319063557822},"availableSpaceAfterExportSize":{"description":"Size of Data Bridge disk space in TB available after export.","type":"string","example":"2 TB"},"totalSpaceBytes":{"description":"Size of available Data Bridge disk space in bytes.","type":"integer","format":"int64","example":4829741056000},"totalSpaceSize":{"description":"Size of available Data Bridge disk space in TB.","type":"string","example":"4 TB"}}},"JobSummary":{"type":"object","properties":{"jobId":{"type":"string","format":"int64","description":"ID of job.","example":54},"priority":{"type":"string","description":"Priority of job.","example":"medium","enum":["verylow","low","medium","high","veryhigh"]},"userName":{"type":"string","format":"email","description":"Login of <<glossary:principal>> that created job, 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"},"status":{"type":"string","description":"Status of export job.","example":"RUNNING","enum":["QUEUED","RUNNING","FINISHED","FAILED","CANCELLED","PENDING","CANCELLING","CANCEL_REQUESTED"]},"submittedAt":{"type":"string","example":"2024-01-01T00:00:00.000Z","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","example":"2024-01-01T00:00:00.000Z","description":"Time job started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, e.g. `2020-01-01T00:00:00.000Z`"},"endedAt":{"type":"string","example":"2024-01-01T00:00:00.000Z","description":"Time job ended 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.","example":"july-data"},"type":{"type":"string","description":"Type of job. See [Platform Jobs](ref:platform-jobs).","example":"DOWNLOAD_RESULTS"},"progress":{"type":"integer","format":"int32","description":"Percentage of job completion.","example":65},"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`, `UNDERWRITEIQ`","example":"RI-RISKMODELER"},"details":{"type":"object","properties":{"resources":{"type":"array","description":"List of <<glossary:resource URI>>s.","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","items":{"$ref":"#/components/schemas/Task"}}}}]},"JobSearchResult":{"type":"array","items":{"$ref":"#/components/schemas/JobSummary"}},"PatchOperation":{"type":"string","enum":["update"]},"ExportInput":{"required":["exportType"],"type":"object","properties":{"fileExtension":{"type":"string","description":"The `exportFormat` attribute specified the format of the exported data (BAK, MDF)","enum":["BAK","MDF"]}}},"EDMRequest":{"type":"object","required":["exportType","resourceUri","resourceType","settings"],"properties":{"exportType":{"type":"string","description":"Type of export job.","enum":["EDM"]},"resourceUri":{"type":"string","format":"uri","description":"URI of EDM resource to export. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/exposures/5555"},"resourceType":{"type":"string","description":"Type of resources to export, e.g. `exposure`.","enum":["exposure"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/EDMSettings"}}},"EDMSettings":{"required":["exportType","fileName","sqlVersion","fileExtension"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"File extension of <<glossary:database artifact>>.","enum":["BAK","MDF"]}}},{"type":"object","properties":{"fileName":{"description":"Name of file that data is exported to.","type":"string"},"sqlVersion":{"type":"string","description":"SQL server version of BAK or MDF <<glossary:database artifact>>.\n\n**Warning:** The Intelligent Risk Platform will end support for SQL Server 2016 in June 2026.","example":"2014","enum":["2019","2016"]}}},{"type":"object","properties":{"filters":{"type":"object","description":"Filters for selecting exposure data to export.","properties":{"exposureResourceType":{"description":"Type of exposure variation to export.","type":"string","enum":["ACCOUNTS","PORTFOLIOS","AGGREGATEPORTFOLIOS"]},"exposureResourceIds":{"type":"array","description":"List of exposures to export identified by resource ID, e.g. `[236, 245, 303]`.","items":{"type":"integer","format":"int32","example":236}}}}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported EDM.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"ExposureResourceRequest":{"type":"object","required":["exportType","resourceUri","resourceType","settings"],"properties":{"exportType":{"type":"string","description":"Type of export job.","enum":["EXPOSURE_RESOURCE"]},"resourceUri":{"type":"string","format":"uri","description":"URI of exposure resource. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/exposures/23/accounts/5555"},"resourceType":{"type":"string","description":"Type of exposure to export, e.g. `account variation`.","enum":["account","portfolio"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/ExposureResourceSettings"}}},"ExposureVariationRequest":{"type":"object","required":["exportType","resourceUri","resourceType","settings"],"properties":{"exportType":{"type":"string","description":"Type of export job.","enum":["EXPOSURE_VARIATION"]},"resourceUri":{"type":"string","format":"uri","description":"URI of exposure variation. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/exposurevariations/23"},"resourceType":{"type":"string","description":"Type of exposure to export, e.g. `account`.","enum":["accountVariation","portfolioVariation","aggregatePortfolioVariation"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/ExposureVariationSettings"}}},"ExposureResourceSettings":{"required":["exportType","fileExtension","fileName"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"File extension of <<glossary:flat file>>, e.g. `PARQUET`.","enum":["PARQUET"]}}},{"type":"object","properties":{"fileName":{"description":"Name of file that data is exported to.","type":"string"}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported data.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"ExposureVariationSettings":{"required":["fileExtension","fileName"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"File extension of <<glossary:flat file>>, e.g. `parquet`.","enum":["parquet"]}}},{"type":"object","properties":{"fileName":{"description":"Name of file (zipped) that data is exported to.","type":"string"}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported data.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"RDMRequest":{"type":"object","required":["exportType","resourceUris","resourceType","settings"],"properties":{"exportType":{"description":"Type of export job.","type":"string","enum":["RDM"]},"resourceUris":{"type":"array","description":"List of analysis results to export identified by resource URI. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/analyses/5555","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":100},"resourceType":{"type":"string","description":"Type of data to export, e.g. `analyses`.","enum":["analyses"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/RDMSettings"}}},"RDMSettings":{"required":["exportType","fileExtension","rdmName"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"File extension of export artifact. One of `BAK`, `MDF`, or `PARQUET`.","enum":["BAK","MDF","PARQUET"]}}},{"type":"object","properties":{"rdmName":{"type":"string","description":"Name of RDM."},"sqlVersion":{"type":"string","description":"SQL Server version of BAK or MDF <<glossary:database artifact>>. Required when `fileExtension` is `BAK` or `MDF`.\n\n**Warning:** The Intelligent Risk Platform will end support for SQL Server 2016 in June 2026.","example":"2019","enum":["2019","2016"]},"exportHdLossesAs":{"type":"string","description":"Loss table for HD analysis result data.","enum":["ELT","PLT"],"default":"ELT"},"lossDetails":{"type":"array","description":"List of losses to export. Each loss is defined `metricType`, `outputLevels`, and `perspectiveCodes`.\n\nAt least one loss table (`LOSS_TABLES`) must be specified, or the operation returns an error.","items":{"type":"object","required":["metricType","perspectiveCodes","outputLevels"],"properties":{"metricType":{"type":"string","description":"Type of data to export. One of `EP`, `LOSS_TABLES`, `STATS`.\n\n`LOSS_TABLES` returns PLT for HD analysis and ELT for ALM or DLM analysis.","enum":["EP","LOSS_TABLES","STATS"]},"outputLevels":{"type":"array","description":"<<glossary:Output level>> of the exported data. Output level can only be exported if analysis includes that level of granularity.\n\nOne or more of `Account`, `Facultative`, `Geographic`, `Location`, `Portfolio`.","items":{"type":"string","enum":["Account","Facultative","Geographic","Location","Portfolio"],"example":"Portfolio"}},"perspectiveCodes":{"type":"array","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)\n","items":{"type":"string","example":"GU"}}}}}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported RDM.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"RDMDatabridgeRequest":{"type":"object","required":["exportType","resourceUris","resourceType","settings"],"properties":{"exportType":{"type":"string","description":"Type of export job.","enum":["RDM_DATABRIDGE"]},"resourceUris":{"type":"array","description":"List of analysis results to export identified by resource URI. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/analyses/5555","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":100},"resourceType":{"type":"string","description":"Type of exported data, e.g. `analyses`.","enum":["analyses"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/RDMDatabridgeSettings"}}},"RDMDatabridgeSettings":{"required":["exportType","serverId"],"type":"object","allOf":[{"type":"object","properties":{"rdmName":{"type":"string","description":"Name of RDM."},"serverId":{"type":"integer","description":"ID of <<glossary:managed server instance>> on Data Bridge.","format":"int64"},"databaseId":{"type":"integer","description":"ID of <<glossary:hosted database>> on managed server instance.\n\nIf specified, results data is exported to existing RDM.","format":"int64"},"exportHdLossesAs":{"type":"string","description":"Loss table for HD analysis result data.","enum":["ELT","PLT"],"default":"ELT"}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of new RDM on Data Bridge. \n\nIgnored if data is exported to an existing <<glossary:hosted RDM>>. Whenever data is exported to an existing RDM on Data Bridge, the database schema version of that RDM is automatically updated to the latest version of the RDM database schema.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"ResultsRequest":{"type":"object","required":["exportType","resourceUris","resourceType","settings"],"properties":{"exportType":{"description":"Type of export job.","type":"string","enum":["RESULTS"]},"resourceUris":{"type":"array","description":"URI of analysis result to export.","example":"/platform/riskdata/v1/analyses/5555","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":1},"resourceType":{"type":"string","description":"Type of resources to export, e.g. `analyses`.","enum":["analyses"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/ResultsSettings"}}},"ResultsSettings":{"required":["exportType","fileExtension","metricType","perspectiveCodes","outputLevels"],"type":"object","allOf":[{"type":"object","required":["fileExtension"],"properties":{"fileExtension":{"description":"File extension of <<glossary:flat file>>.","type":"string","enum":["CSV","PARQUET"]},"additionalOutputs":{"description":"For HD non-EP analyses only. One or more of `DAMAGE`, `HAZARD`, or `UNCERTAINTY` to export tables of this data.","type":"array","items":{"type":"string","enum":["DAMAGE","HAZARD","UNCERTAINTY"],"example":["DAMAGE","HAZARD","UNCERTAINTY"]}},"lossDetails":{"type":"array","description":"List of losses to export. Each loss is defined by its `metricType`, an array of `outputLevels`, and an array of `perspectiveCodes`.\n\nAt least one loss table (`LOSS_TABLES`) must be specified, or the operation returns an error.","items":{"type":"object","required":["metricType","perspectiveCodes","outputLevels"],"properties":{"metricType":{"type":"string","description":"Type of data to export. One of `EP`, `LOSS_TABLES`, `STATS`.\n\n`LOSS_TABLES` returns PLT for HD analysis and ELT for ALM or DLM analysis.","enum":["EP","LOSS_TABLES","STATS"]},"outputLevels":{"type":"array","description":"Resolution (granularity) of the exported data. Output level can only be exported if analysis includes that level of granularity.","items":{"type":"string"}},"perspectiveCodes":{"type":"array","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)\n","example":["GU","GR"],"items":{"type":"string"}}}}},"nonWeightedPlt":{"type":"boolean","description":"If `true`, HD earthquake EP analysis results are exported as equally-weighted PLTs for download. By default, these results are exported as the weighted PLTs originally generated using the HD Earthquake model."}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported data.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"LocationResultsRequest":{"type":"object","required":["exportType","resourceUris","resourceType","settings"],"properties":{"exportType":{"description":"Type of export job.","type":"string","enum":["LOCATION_RESULTS"]},"resourceUris":{"type":"array","description":"List of location-level analysis results to export identified by resource URI, e.g. `/platform/riskdata/v1/analyses/555`. See [Resource URIs](doc:resource-uris).\n\nMax number resource URIs dependent on entitlement:\n  * `RI-UNDERWRITEIQ`: Up to 100 resource URIs.\n  * `RI-EXPOSUREIQ` and `RI-RISKMODELER`: Up to 15 resource URIs.","example":"/platform/riskdata/v1/analyses/555","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":100},"resourceType":{"type":"string","description":"Type of resources to export, e.g. `analyses`.","enum":["analyses"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/LocationResultsSettings"}}},"LocationResultsSettings":{"required":["exportType","fileExtension","perspectiveCodes","fileName"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"File format of <<glossary:flat file>>, e.g. `CSV`.","enum":["CSV"]},"exposureFields":{"type":"array","description":"List of location properties to export to flat file.  For a complete list, see [Export API Overview](ref:export-api-overview).","items":{"type":"string"}},"perspectiveCodes":{"type":"array","description":"Financial perspective that determines how losses are calculated. See [Financial Perspectives](doc:financial-perspectives)","example":["GU","GR"],"items":{"type":"string"}},"fileName":{"description":"Name of file that data is exported to.","type":"string"}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported data.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"RollupResultsRequest":{"type":"object","required":["exportType","resourceUris","resourceType","settings"],"properties":{"exportType":{"description":"Type of export job.","type":"string","enum":["ROLLUP_RESULTS"]},"resourceUris":{"type":"array","description":"List of rollup analysis results identified by resource URI, e.g. `/platform/riskdata/v1/analyses/555`. See [Resource URIs](doc:resource-uris).","example":"/platform/riskdata/v1/analyses/5555","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":1},"resourceType":{"type":"string","description":"Type of resources to export, e.g. `analyses`.","enum":["analyses"]},"settings":{"description":"Export job settings.","$ref":"#/components/schemas/RollupResultsSettings"}}},"RollupResultsSettings":{"required":["exportType","lossDetails"],"type":"object","allOf":[{"type":"object","properties":{"fileExtension":{"type":"string","description":"Extension of <<glossary:flat file>>.","enum":["CSV","PARQUET"]},"lossDetails":{"type":"object","description":"Filters for exported rollup analysis data. Available filters depend on output data exported. One of `ep`, `plt`, `stats`","oneOf":[{"type":"object","required":["ep"],"properties":{"ep":{"$ref":"#/components/schemas/RollupLossDetail"}}},{"type":"object","required":["plt"],"properties":{"plt":{"$ref":"#/components/schemas/RollupLossDetail"}}},{"type":"object","required":["stats"],"properties":{"stats":{"$ref":"#/components/schemas/RollupLossDetail"}}}]}}},{"type":"object","properties":{"schemaVersion":{"description":"Database schema version of exported data.","type":"string","enum":["v18","v21","v22","v23","v24","v25"]}}}]},"RollupLossDetail":{"type":"object","properties":{"includeSegmented":{"type":"boolean","default":false,"description":"If `true`, segmented data is exported."},"includeUnSegmented":{"type":"boolean","description":"If `true`, unsegmented data is exported.","default":false},"positionTypes":{"type":"array","description":"List of positions to export. One or more of `ASSUMED`, `CEDED`, `CONTRACT`, `CONTRACT_ASSUMED`, `CONTRACT_SUBJECT`, `GROSS`, `NET`, `NODE`, `PROGRAM`, `RETRO_CONTRACT`, `RETRO_CONTRACT_SUBJECT`.","items":{"type":"string","uniqueItems":true,"enum":["ASSUMED","CEDED","CONTRACT","CONTRACT_ASSUMED","CONTRACT_SUBJECT","GROSS","NET","NODE","PROGRAM","RETRO_CONTRACT","RETRO_CONTRACT_SUBJECT"]}}}},"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"}}}}