{"openapi":"3.0.2","info":{"title":"Enrich Exposure API","version":"2023.12.b"},"servers":[{"url":"https://{host}/platform/enrichexposure/v1","variables":{"host":{"enum":["api-euw1.rms.com","api-use1.rms.com"],"default":"api-euw1.rms.com","description":"Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com"}}}],"x-readme":{"explorer-enabled":false,"parameter-ordering":["header","path","query","body","form","cookie"],"samples-languages":["curl","java","csharp","node","python"],"proxy-enabled":true,"samples-enabled":true},"security":[{"rms_api_key":[]},{"rms_bearer_token":[]}],"paths":{"/jobs":{"post":{"tags":["Enrich Exposure Jobs"],"summary":"Enrich exposure","operationId":"createEnrichExposureJob","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/PortfolioEnrichRequest"},{"$ref":"#/components/schemas/AccountEnrichRequest"}],"discriminator":{"propertyName":"resourceType","mapping":{"portfolio":"#/components/schemas/PortfolioEnrichRequest","account":"#/components/schemas/PortfolioEnrichRequest"}}}}}},"responses":{"201":{"description":"Enrich Exposure job created and accepted","headers":{"Location":{"description":"location of the job with jobId","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":["Enrich Exposure Jobs"],"summary":"Search enrich exposure jobs","operationId":"getEnrichExposureJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\nSupported properties: `endedAt`, `jobId`, `name`, `startedAt`, `status`, `type`, `userName`. See [Filtering Responses](doc:response-filtering#enrich-exposure-jobs).","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`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of retrieved records to display on the 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":["Enrich Exposure Jobs"],"summary":"Get enrich exposure job","operationId":"getEnrichExposureJob","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":["Enrich Exposure Jobs"],"summary":"Update enrich exposure job","operationId":"updateEnrichExposureJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of enrich exposure job.","enum":["CANCELED"]},"priority":{"type":"string","description":"Priority of enrich exposure 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"}}}}}}}},"components":{"parameters":{"JobIdParam":{"name":"jobId","in":"path","description":"ID of job.","schema":{"type":"string"},"required":true}},"schemas":{"BackupDetails":{"type":"object","description":"Exposure backup details. Required if `createBackup` is `true`.","properties":{"exposureResourceName":{"description":"Name of exposure backup.","type":"string"},"exposureResourceNumber":{"description":"ID of exposure backup.","type":"string"}}},"PortfolioEnrichRequest":{"required":["resourceType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"type":"string","description":"URI of portfolio.","example":"/riskdata/v1/exposures/1/portfolios/1"},"resourceType":{"type":"string","description":"Type of resource.","enum":["portfolio"]},"settings":{"$ref":"#/components/schemas/EnrichExposureSettings"}}},"AccountEnrichRequest":{"required":["resourceType","resourceUri","settings"],"type":"object","properties":{"resourceUri":{"description":"URI of account.","type":"string","example":"/riskdata/v1/exposures/1/accounts/1"},"resourceType":{"type":"string","description":"Type of resource.","enum":["account"]},"settings":{"$ref":"#/components/schemas/EnrichExposureSettings"}}},"EnrichExposureSettings":{"type":"object","properties":{"retrieveData":{"description":"Retrieve data from <<glossary:ESDB>>. By default, `false`.","type":"boolean"},"esdbVersion":{"description":"Version of ESDB. By default, `Latest`.","type":"string"},"transferData":{"description":"Update exposure with ESDB data. By default, `false`.","type":"boolean"},"overwriteAll":{"description":"Perserve or overwrite exposure data. By default, `false`.\n\n  - If `true`, overwrite exposure data with ESDB data. \n  - If `false`, preserve exposure data. Update properties with blank or default values.\ntype: boolean"},"createBackup":{"description":"Create backup of exposure before updating. By default, `false`.\n\n  If `true`, `tranferData` is required. \ntype: boolean"},"backupDetails":{"$ref":"#/components/schemas/BackupDetails"}}},"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","description":"Unique ID of task.","format":"uuid"},"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","description":"Time data job 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 data job was started 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."}}}}},"JobSummary":{"type":"object","properties":{"jobId":{"type":"string","description":"ID of enrich exposure job.","format":"int64"},"priority":{"type":"string","description":"Priority of enrich exposure job.","enum":["verylow","low","medium","high","veryhigh"]},"userName":{"type":"string","format":"email","description":"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](principals).","example":"user.name@company.com"},"status":{"type":"string","description":"Status of enrich exposure job.","enum":["CANCELLED","CANCELLING","CANCEL_REQUESTED","FAILED","FINISHED","PENDING","QUEUED","RUNNING"]},"submittedAt":{"type":"string","description":"Date 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":"Date 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":"Date 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."},"type":{"type":"string","description":"Type of job. See [Platform Jobs](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 the 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 <<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","description":"List of task objects. A batch job consists of multiple child tasks.","items":{"$ref":"#/components/schemas/Task"}}}}]},"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"}}}}