{"openapi":"3.0.2","info":{"title":"ESG Data API","version":"2024.06.d"},"servers":[{"url":"https://{host}/esgdata/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":{"/companies":{"get":{"tags":["ESG Companies"],"summary":"Search ESG companies","operationId":"getEsgCompanies","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values.\n\n|Property|Data Type| Comparison|\n|:---|:---| :---|\n|`ISIN` |`number` |`=`|\n|`addressLine1`|`string`|  `=`|\n|`addressLine2`|`string`| `=`|\n|`addressLine3`|`string`|`=`|\n|`city`|`string` |`=`|\n|`companyId1`|`string`|`=`|\n|`companyId2`|`string`|`=`|\n|`country`|`string`|`=`|\n|`countryIsoCode`|`string`|`=`|\n|`localName`|`string`|`=`|\n|`naceRev2`|`string`|`=`|\n|`naceRev2Code`|`string`|`=`|\n|`name`|`string`|`=`|\n|`orbisId`| string`|`=`|\n|`state`|`string`|`=`|\n|`status`|`string`|`=`|\n|`telephone`|`string`|`=`|\n|`ticker`|`string`|`=`|\n|`website`|`string`|`=`|\n\nTo learn more, see [Response Filtering](doc:response-filtering).","required":true,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma-delimited list of properties. Sort order defined by one of `ASC` (ascending) or `DESC` (descending).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","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":{"type":"array","items":{"$ref":"#/components/schemas/CompanySearchRecord"}}}}},"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"}}}}}}},"/companies/{orbisId}":{"get":{"tags":["ESG Companies"],"summary":"Get ESG company","operationId":"getEsgCompany","parameters":[{"name":"orbisId","in":"path","description":"Nine-digit ID of ESG company in the Moody's ORBIS database.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDashboardResult"}}}},"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"}}}}}}},"/companies/match":{"post":{"tags":["ESG Companies"],"summary":"Match ESG companies","operationId":"matchEsgCompanies","parameters":[{"name":"x-rms-resource-group-id","in":"header","required":true,"description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-groups).","schema":{"type":"string","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PortfolioVariationMatchRequest"}],"discriminator":{"propertyName":"resourceType","mapping":{"portfolioVariation":"#/components/schemas/PortfolioVariationMatchRequest"}}}}}},"responses":{"202":{"description":"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"}}}}}}},"/reports":{"post":{"tags":["ESG Reports"],"summary":"Create ESG report","operationId":"createEsgReport","parameters":[{"name":"x-rms-resource-group-id","in":"header","description":"ID of <<glossary:resource group>>. To learn more, see [Resource Groups](doc:resource-groups).","schema":{"type":"string","format":"uuid","default":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EsgExposureSummaryReportRequest"},{"$ref":"#/components/schemas/EsgDetailsReportRequest"},{"$ref":"#/components/schemas/PcafDetailsReportRequest"}],"discriminator":{"propertyName":"reportType","mapping":{"ESG_EXPOSURE_SUMMARY":"#/components/schemas/EsgExposureSummaryReportRequest","ESG_DETAILS":"#/components/schemas/EsgDetailsReportRequest","PCAF_DETAILS":"#/components/schemas/PcafDetailsReportRequest"},"required":true}}}},"required":true},"responses":{"201":{"description":"ESG Report job created and accepted","headers":{"Location":{"description":"Location of the job with jobId","style":"simple","schema":{"type":"string","format":"URI"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"404":{"description":"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":["ESG Reports"],"summary":"Search ESG reports","operationId":"getEsgReports","parameters":[{"name":"filter","in":"query","description":"\nSupported properties: `createdAt` `createdBy` `reportId` `reportName` \n\n|Property|Data Type|Comparison|List|\n|:--------|:--------|:--------|:--------|\n|`createdAt`|`YYYY-MM-DD`|`>=`, `<=`  ||\n|`createdBy`|`string`|`=`  ||\n|`reportId`|`string`|`=`  | `IN`|\n|`reportName`|`string`|`=`  | `IN`|\n\nFor example, `reportName=\"abc\" AND createdAt>=\"2023-09-10\" AND createdBy=\"user@rms.com\"` See [Filtering Responses](doc:response-filtering)","schema":{"maxLength":5000,"minLength":0,"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","schema":{"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"Number of the page displaying the returned records, starting at _0_","schema":{"maximum":100,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportSummary"}}}}},"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"}}}}}}},"/reports/{reportId}":{"get":{"tags":["ESG Reports"],"summary":"Get ESG report","operationId":"getEsgReport","parameters":[{"name":"reportId","in":"path","description":"ID of ESG report.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"}}}},"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":{"get":{"tags":["ESG Jobs"],"summary":"Search ESG jobs","operationId":"getEsgDataJobs","parameters":[{"name":"filter","in":"query","description":"<<glossary:Query string>> to select response data based on property values. \n\n|Property|Data Type|Comparision|List|\n|:---|:---|:----|:---|\n|`endedAt`|`string`|`=`||\n|`jobId`|`string`|`=`|`IN`|\n|`name`|`string`|`=`||\n|`startedAt`|`string`|`=`||\n|`status`|`string`|`=`||\n|`type`|`string`|`=`||\n|`userName`|`string`|`=`||\n\nOperators depend on the data type of the property. See [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`. See [Response Pagination](doc:response-pagination).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of records returned per page. See [Response Pagination](doc:response-pagination)","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":["ESG Jobs"],"summary":"Get ESG job","operationId":"getEsgDataJob","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":["ESG Jobs"],"summary":"Update ESG job","operationId":"updateEsgDataJob","parameters":[{"$ref":"#/components/parameters/JobIdParam"}],"requestBody":{"description":"Updates to ESG job.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of ESG data job.","enum":["CANCELED"]},"priority":{"type":"string","description":"Priority of ESG data job.","enum":["High","Medium","Low"]}}}}}},"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":{"CompanyDashboardResult":{"type":"object","properties":{"bvdId":{"type":"string","description":"ID of insured company in at least one Moody's product. First two characters correspond to the ISO 3166-1 Alpha-2 country code."},"orbisId":{"type":"string","description":"Nine-digit ID of ESG company in the Moody's ORBIS database."},"name":{"type":"string","description":"Name of insured country."},"naceRev2":{"description":"Four-digit code that identifies the company's principal economic activity (NACE Rev 2) using the Nomenclature of Economic Activities (NACE Rev 2) classification system. Available if company is in Orbis database.","$ref":"#/components/schemas/NaceRev2"},"addressLine1":{"type":"string","description":"Portion of insured company's street address. Available if imported with account data."},"addressLine2":{"type":"string","description":"Portion of insured company's street address. Available if imported with account data."},"addressLine3":{"type":"string","description":"Portion of insured company's street address. Available if imported with account data."},"city":{"type":"string","description":"Insured company's city. Available if imported with account data."},"stateOrProvinceInUsOrCanada":{"type":"string","description":"Insured company's state or province. Available if imported with account data."},"postalCode":{"type":"string","description":"Insured company's postal code. Available if imported with account data."},"countryName":{"type":"string","description":"Name of country of insured company. Available if imported with account data."},"countryIsoCode":{"type":"string","description":"ISO country code of where the insured company is incorporated. Available if imported with account data."},"esgScores":{"$ref":"#/components/schemas/EsgScores"},"detailedEsgScores":{"$ref":"#/components/schemas/DetailedEsgScores"},"moodysReferenceDomainEsgScores":{"type":"array","items":{"$ref":"#/components/schemas/NameValueDouble"}},"carbonScope":{"type":"array","items":{"$ref":"#/components/schemas/NameValueDouble"}},"historicalScores":{"$ref":"#/components/schemas/HistoricalScores"},"benchmarkScores":{"$ref":"#/components/schemas/BenchmarkScoresHolder"},"detailedMetricsPdf":{"type":"string"},"pcafDetails":{"$ref":"#/components/schemas/PcafDetails"},"chaucerEsgScores":{"$ref":"#/components/schemas/CustomDetailedEsgScores"}}},"BenchmarkScore":{"type":"object","description":"Indicates overall ESG score relative to other companies. Benchmark calculations do not include subsidiary scores or scores less than zero (0).","properties":{"sectorBenchmark":{"type":"array","description":"Minimum, non-weighted average,and maximum scores for other companies in the same sector (4-digit NACE Rev 2 code).","items":{"$ref":"#/components/schemas/NameValueDouble"}},"countryBenchmark":{"type":"array","description":"Minimum,non-weighted average,and maximum scores for other companies in the same country","items":{"$ref":"#/components/schemas/NameValueDouble"}}}},"PcafDetails":{"type":"object","properties":{"assetTurnover":{"type":"integer","format":"int64","description":"Impact on the portfolio's ESG scores by removing the account, based on the turnover revenue generated from the company's overall holding of assets."},"assetTurnoverCurrency":{"type":"string","description":"Currency used in asset turn over calculation."},"carbonEmissionScope1and2":{"type":"number","format":"double","description":"Amount of greenhouse emissions, in metric tCO2e, from Scope 1 and 2."},"estimatedScope1and2":{"type":"string"},"thirdPartyVerification":{"type":"string"},"estimationJustification":{"type":"string"},"carbonEmissionScope3":{"type":"number","format":"double"},"estimatedScope3":{"type":"string"},"carbonFootprintReportingYear":{"type":"integer","format":"int32"},"evic":{"type":"integer","format":"int64","description":"Estimated total value of company operations based on the sum of its market capitalization, long-term debts, and loans to financial institutions, including cash and cash equivalents. Used to calculate the company's Financed Emissions and Emissions Intensity."},"evicCurrency":{"type":"string","description":"Currency used in calculation of `evic`."}}},"BenchmarkScoresHolder":{"type":"object","properties":{"benchmarkScoreESG":{"$ref":"#/components/schemas/BenchmarkScore"},"benchmarkScoreE":{"$ref":"#/components/schemas/BenchmarkScore"},"benchmarkScoreS":{"$ref":"#/components/schemas/BenchmarkScore"},"benchmarkScoreG":{"$ref":"#/components/schemas/BenchmarkScore"}}},"CustomDetailedEsgScores":{"type":"object"},"DetailedEsgScores":{"type":"object","properties":{"environmental":{"type":"array","description":"ESG score that identifies a company's overall management against various environmental criterion. It assesses the company's use of natural resources and the effect the company and its supply chains have on the environment.","items":{"$ref":"#/components/schemas/NameValueDouble"}},"social":{"type":"array","description":"ESG score that identifies a company's overall management against various social criterion. It assesses the company's interaction with its employees, suppliers, customers, and communities in which it operates.","items":{"$ref":"#/components/schemas/NameValueDouble"}},"governance":{"type":"array","description":"ESG score that identifies a company's overall management across various corporate governance criteria. It assesses the extent to which ESG has been integrated across the operations of the Board, Audit, Shareholders, and Remuneration functions, as well as whether the company follows good practices in terms of business ethics (preventing corruption, anti- competitive practices, and transparent lobbying).","items":{"$ref":"#/components/schemas/NameValueDouble"}}}},"DriverRecord":{"type":"object","properties":{"modelVersion":{"type":"string"}}},"EsgScores":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"overallEsgScore":{"type":"integer","description":"Measurement the insured company's performance across environmental, social, and governance factors.\n\nHigh score indicates that the company follows best practices effectively in all environmental, social, and governance areas with a minimal negative impact on its employees or the environment. A mid-range score means that the company meets best practices in most ESG categories and has a low negative impact on its employees or the environment. In contrast, a low score indicates that the company does not follow best practices, negatively impacting its employees and the environment.","format":"int32"},"overallEnvironmentalScore":{"type":"integer","format":"int32"},"overallSocialScore":{"type":"integer","format":"int32"},"overallGovernanceScore":{"type":"integer","format":"int32"},"scoreType":{"type":"string"}}},"HistoricalScore":{"type":"object","properties":{"driver":{"$ref":"#/components/schemas/DriverRecord"},"esgScores":{"$ref":"#/components/schemas/EsgScores"},"detailedEsgScores":{"$ref":"#/components/schemas/DetailedEsgScores"},"moodysReferenceDomainEsgScores":{"type":"array","items":{"$ref":"#/components/schemas/NameValueDouble"}}}},"HistoricalScores":{"type":"object","properties":{"totalRecordsCount":{"type":"integer","format":"int64"},"records":{"type":"array","items":{"$ref":"#/components/schemas/HistoricalScore"}}}},"NaceRev2":{"type":"object","properties":{"coreCode":{"type":"string","description":"Four-digit ID that identifies NACE Rev2 industry code."},"coreCodeText":{"type":"string","description":"Name of NACE Rev2 industry."}}},"NameValueDouble":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number","format":"double"}}},"CompanySearchRecord":{"type":"object","properties":{"matchConfidence":{"type":"integer","format":"int32"},"orbisId":{"type":"string","description":"Nine-digit ID of ESG company in the Moody's ORBIS database."},"name":{"type":"string","description":"Name of ESG company."},"previousNames":{"type":"array","description":"List of previous names of ESG company.","items":{"type":"string"}},"naceRev2Code":{"type":"string","description":"Four-digit code that identifies the company's principal economic activity (NACE Rev 2) using the Nomenclature of Economic Activities (NACE Rev 2) classification system. Available if company is in Orbis database.","example":4721},"naceRev2Description":{"type":"string","description":"Description of NACE Rev2 classification.","example":"Retail sale of fruit and vegetables in specialised stores"},"countryName":{"type":"string","description":"Name of country of insured company."},"countryIsoCode":{"type":"string","description":"ISO country code of where the insured company is incorporated."},"addressLine1":{"type":"string","description":"Portion of insured company's street address."},"addressLine2":{"type":"string","description":"Portion of insured company's street address."},"addressLine3":{"type":"string","description":"Portion of insured company's street address."},"city":{"type":"string","description":"Insured company's city."},"stateOrProvinceInUsOrCanada":{"type":"string","description":"Insured company's state or province."},"website":{"type":"string","description":"Website of company.","example":"https://www.company.com"},"telephone":{"type":"string","description":"Telephone number of company.","example":"1-555-555-1234"},"otherCompanyIds":{"type":"array","items":{"type":"string"}},"tickers":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"industryCode":{"type":"string"},"regionalClassification":{"type":"string"},"assetTurnover":{"type":"integer","format":"int64","description":"Revenue generated from insured company's overall holding of assets in US dollars. Used to calculate the weighted average ESG scores by asset turnover. Available if imported with the account data."},"totalAssets":{"type":"integer","format":"int64","description":"Total market value of assets held by the company in US dollars. Used to calculate the portfolio's weighted average ESG scores based on total assets. Available if imported with account data."},"numberOfEmployees":{"type":"integer","format":"int64","description":"Number of employees on insured company's payroll. Used to calculate weighted average ESG score by employees. Available if imported with account data."},"isins":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"PortfolioVariationMatchRequest":{"type":"object","required":["resourceUri","resourceType"],"properties":{"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation."},"resourceType":{"type":"string","description":"Type of resource, e.g. `portfolioVariation`.","enum":["portfolioVariation"]},"settings":{"type":"object","description":"Accounts within portfolio variation to update. Overrides previously matched accounts with ESG scores and emission data for the specified ESG company.","properties":{"overrides":{"type":"object","description":"Identification of reference portfolio varation.","properties":{"referenceResourceUri":{"type":"string","format":"uri","description":"URI of reference portfolio variation."},"referenceResourceType":{"type":"string","description":"Type of reference resource, e.g `portfolioVariation`.","enum":["portfolioVariation"]},"overrideList":{"type":"array","description":"Match account to ESG company.","items":{"type":"object","properties":{"accountId":{"type":"string","description":"ID of account."},"orbisId":{"type":"string","description":"Nine-digit ID of ESG company in the Moody's ORBIS database."}}}}}}}}}},"ErrorMessage":{"type":"object","properties":{"logId":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}},"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 job. See [Platform Jobs](ref:platform-jobs)."},"status":{"type":"string","description":"Status of task. 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 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","format":"int64","description":"ID of job. See [Platform Jobs](ref:platform-jobs)."},"priority":{"type":"string","description":"Priority of 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 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 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 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 portfolio variation <<glossary:resource URI>>s.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","example":"/platform/riskdata/v1/exposurevariations/5555"}}}},"summary":{"type":"string"}}}}},"Job":{"type":"object","allOf":[{"$ref":"#/components/schemas/JobSummary"},{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}]},"EsgExposureSummaryReportRequest":{"type":"object","required":["reportType","resourceUri","resourceType"],"properties":{"reportType":{"type":"string","description":"Type of report.","enum":["ESG_EXPOSURE_SUMMARY"]},"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation resource.","example":"/platform/riskdata/v1/exposurevariations/5555"},"resourceType":{"type":"string","enum":["portfolioVariation"]},"settings":{"$ref":"#/components/schemas/EsgExposureSummaryReportSettings"}}},"EsgDetailsReportRequest":{"type":"object","required":["reportType","resourceUri","resourceType"],"properties":{"reportType":{"type":"string","description":"Type of report.","enum":["ESG_DETAILS"]},"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation resource.","example":"/platform/riskdata/v1/exposurevariations/5555"},"resourceType":{"type":"string","description":"URI of resource.","enum":["portfolioVariation"]},"settings":{"$ref":"#/components/schemas/EsgDetailsReportSettings"}}},"PcafDetailsReportRequest":{"type":"object","required":["reportType","resourceUri","resourceType"],"properties":{"reportType":{"type":"string","description":"Type of report.","enum":["PCAF_DETAILS"]},"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation resource.","example":"/platform/riskdata/v1/exposurevariations/5555"},"resourceType":{"type":"string","enum":["portfolioVariation"]},"settings":{"$ref":"#/components/schemas/PcafDetailsReportSettings"}}},"EsgExposureSummaryReportSettings":{"type":"object","required":["fileName","fileType","includeAccounts"],"properties":{"fileName":{"type":"string","description":"Name of file."},"fileType":{"type":"string","description":"Type of file, e.g. `csv`.","enum":["csv"]},"includeAccounts":{"type":"boolean"}}},"EsgDetailsReportSettings":{"type":"object","required":["fileName","fileType","includeAccounts"],"properties":{"fileName":{"type":"string","description":"Name of file."},"fileType":{"type":"string","description":"Type of file, e.g. `csv`.","enum":["csv"]},"includeAccounts":{"type":"boolean"}}},"PcafDetailsReportSettings":{"type":"object","required":["fileName","fileType","includeAccounts","data"],"properties":{"fileName":{"type":"string","description":"Name of file."},"fileType":{"type":"string","description":"Type of file, e.g. `csv`.","enum":["csv"]},"includeAccounts":{"type":"boolean"},"data":{"type":"array","items":{"type":"string","enum":["insurance_associated_emissions","financed_emissions"],"minItems":1}}}},"Report":{"type":"object","properties":{"reportName":{"type":"string","description":"Name of report."},"reportType":{"type":"string","description":"Type of report."},"createdBY":{"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"},"createdAt":{"type":"string","description":"Date report was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `2020-01-01T00:00:00.000Z`.","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"workflowId":{"type":"string"},"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation resource.","example":"/platform/riskdata/v1/exposurevariations/5555"},"status":{"type":"string","description":"Status of job."},"presignedUrl":{"type":"string","description":"URL for downloading report."}}},"ReportSummary":{"type":"object","properties":{"reportName":{"type":"string","description":"Name of report."},"reportId":{"type":"string","description":"ID of report."},"createdBy":{"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"},"createdAt":{"type":"string","description":"Date report was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `2020-01-01T00:00:00.000Z`.","format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","example":"2020-01-01T00:00:00.000Z"},"resourceUri":{"type":"string","format":"uri","description":"URI of portfolio variation resource.","example":"/platform/riskdata/v1/exposurevariations/5555"}}}},"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"}}}}