POST v1/Entities/CalculateCAEScenariosByBatch

Calculates the cae scenarios by batch.

Request Information

Parameters

Name	Type	Description	Additional information
request	ScenarioInputs	The request.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "entityInputs": [
    {
      "identifiers": {
        "entityName": "sample string 1",
        "entityIdentifier": "sample string 2",
        "financialStatementDate": "2026-06-05T14:54:08.000564+00:00",
        "carbonEmissionDate": "2026-06-05T14:54:08.000564+00:00",
        "asOfDate": "2026-06-05T14:54:08.000564+00:00"
      },
      "qualitativeInputs": {
        "regions": [
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          }
        ],
        "industryDetails": [
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          }
        ],
        "probabilityDefault": 1.1,
        "rating": "sample string 1",
        "inputScope": "sample string 2"
      },
      "quantativeInputs": {
        "totalAssets": 1.1,
        "totalSales": 1.1,
        "scope1Emission": 1.1,
        "scope2Emission": 1.1,
        "carbonFootPrint": 1.1
      }
    },
    {
      "identifiers": {
        "entityName": "sample string 1",
        "entityIdentifier": "sample string 2",
        "financialStatementDate": "2026-06-05T14:54:08.000564+00:00",
        "carbonEmissionDate": "2026-06-05T14:54:08.000564+00:00",
        "asOfDate": "2026-06-05T14:54:08.000564+00:00"
      },
      "qualitativeInputs": {
        "regions": [
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          }
        ],
        "industryDetails": [
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          }
        ],
        "probabilityDefault": 1.1,
        "rating": "sample string 1",
        "inputScope": "sample string 2"
      },
      "quantativeInputs": {
        "totalAssets": 1.1,
        "totalSales": 1.1,
        "scope1Emission": 1.1,
        "scope2Emission": 1.1,
        "carbonFootPrint": 1.1
      }
    },
    {
      "identifiers": {
        "entityName": "sample string 1",
        "entityIdentifier": "sample string 2",
        "financialStatementDate": "2026-06-05T14:54:08.000564+00:00",
        "carbonEmissionDate": "2026-06-05T14:54:08.000564+00:00",
        "asOfDate": "2026-06-05T14:54:08.000564+00:00"
      },
      "qualitativeInputs": {
        "regions": [
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          },
          {
            "regionName": "sample string 1",
            "regionWeight": 2.1
          }
        ],
        "industryDetails": [
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          },
          {
            "industryType": "sample string 1",
            "industryCode": "sample string 2",
            "industryWeight": 3.1
          }
        ],
        "probabilityDefault": 1.1,
        "rating": "sample string 1",
        "inputScope": "sample string 2"
      },
      "quantativeInputs": {
        "totalAssets": 1.1,
        "totalSales": 1.1,
        "scope1Emission": 1.1,
        "scope2Emission": 1.1,
        "carbonFootPrint": 1.1
      }
    }
  ],
  "physicalScore": [
    {
      "identifier": "sample string 1",
      "totalscore427": 2
    },
    {
      "identifier": "sample string 1",
      "totalscore427": 2
    },
    {
      "identifier": "sample string 1",
      "totalscore427": 2
    }
  ],
  "expectPath": [
    {
      "year": 1,
      "eP.NoDamPrice": 2,
      "eP.EP": 3.1,
      "eP.LP": 4.1,
      "eP.NP": 5.1,
      "lP.NoDamPrice": 6,
      "lP.EP": 7.1,
      "lP.LP": 8.1,
      "lP.NP": 9.1,
      "nP.NoDamPrice": 10,
      "nP.EP": 11.1,
      "nP.LP": 12.1,
      "nP.NP": 13.1
    },
    {
      "year": 1,
      "eP.NoDamPrice": 2,
      "eP.EP": 3.1,
      "eP.LP": 4.1,
      "eP.NP": 5.1,
      "lP.NoDamPrice": 6,
      "lP.EP": 7.1,
      "lP.LP": 8.1,
      "lP.NP": 9.1,
      "nP.NoDamPrice": 10,
      "nP.EP": 11.1,
      "nP.LP": 12.1,
      "nP.NP": 13.1
    },
    {
      "year": 1,
      "eP.NoDamPrice": 2,
      "eP.EP": 3.1,
      "eP.LP": 4.1,
      "eP.NP": 5.1,
      "lP.NoDamPrice": 6,
      "lP.EP": 7.1,
      "lP.LP": 8.1,
      "lP.NP": 9.1,
      "nP.NoDamPrice": 10,
      "nP.EP": 11.1,
      "nP.LP": 12.1,
      "nP.NP": 13.1
    }
  ],
  "discountPath": [
    {
      "year": 1,
      "eP.DF": 2.1,
      "lP.DF": 3.1,
      "nP.DF": 4.1
    },
    {
      "year": 1,
      "eP.DF": 2.1,
      "lP.DF": 3.1,
      "nP.DF": 4.1
    },
    {
      "year": 1,
      "eP.DF": 2.1,
      "lP.DF": 3.1,
      "nP.DF": 4.1
    }
  ],
  "soverignScore": [
    {
      "isO3": "sample string 1",
      "sovereignScore": 2
    },
    {
      "isO3": "sample string 1",
      "sovereignScore": 2
    },
    {
      "isO3": "sample string 1",
      "sovereignScore": 2
    }
  ],
  "damagePath": [
    {
      "year": 1,
      "disorderly_median": 2.1,
      "hot_house_median": 3.1,
      "hot_house_p95": 4.1,
      "orderly_median": 5.1
    },
    {
      "year": 1,
      "disorderly_median": 2.1,
      "hot_house_median": 3.1,
      "hot_house_p95": 4.1,
      "orderly_median": 5.1
    },
    {
      "year": 1,
      "disorderly_median": 2.1,
      "hot_house_median": 3.1,
      "hot_house_p95": 4.1,
      "orderly_median": 5.1
    }
  ],
  "physical": false,
  "transition": false,
  "switchPer": 3.1,
  "discountYearly": 4.1,
  "scenariosCategory": "sample string 5",
  "resultDetailMain": false,
  "resultDetailTransition": false
}

application/xml, text/xml

Sample:

<ScenarioInputs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MA.CreditEdge.DataObjects.ClimateAdjustedEdf">
  <DamagePath>
    <CAEDamagePath>
      <disorderly_median>2.1</disorderly_median>
      <hot_house_median>3.1</hot_house_median>
      <hot_house_p95>4.1</hot_house_p95>
      <orderly_median>5.1</orderly_median>
      <year>1</year>
    </CAEDamagePath>
    <CAEDamagePath>
      <disorderly_median>2.1</disorderly_median>
      <hot_house_median>3.1</hot_house_median>
      <hot_house_p95>4.1</hot_house_p95>
      <orderly_median>5.1</orderly_median>
      <year>1</year>
    </CAEDamagePath>
    <CAEDamagePath>
      <disorderly_median>2.1</disorderly_median>
      <hot_house_median>3.1</hot_house_median>
      <hot_house_p95>4.1</hot_house_p95>
      <orderly_median>5.1</orderly_median>
      <year>1</year>
    </CAEDamagePath>
  </DamagePath>
  <DiscountPath>
    <CAEDiscountPath>
      <EPDF>2.1</EPDF>
      <LPDF>3.1</LPDF>
      <NPDF>4.1</NPDF>
      <year>1</year>
    </CAEDiscountPath>
    <CAEDiscountPath>
      <EPDF>2.1</EPDF>
      <LPDF>3.1</LPDF>
      <NPDF>4.1</NPDF>
      <year>1</year>
    </CAEDiscountPath>
    <CAEDiscountPath>
      <EPDF>2.1</EPDF>
      <LPDF>3.1</LPDF>
      <NPDF>4.1</NPDF>
      <year>1</year>
    </CAEDiscountPath>
  </DiscountPath>
  <DiscountYearly>4.1</DiscountYearly>
  <EntityInputs>
    <EntityCalculateCAEScenarioInput>
      <Identifiers>
        <AsOfDate>2026-06-05T14:54:08.000564+00:00</AsOfDate>
        <CarbonEmissionDate>2026-06-05T14:54:08.000564+00:00</CarbonEmissionDate>
        <EntityIdentifier>sample string 2</EntityIdentifier>
        <EntityName>sample string 1</EntityName>
        <FinancialStatementDate>2026-06-05T14:54:08.000564+00:00</FinancialStatementDate>
      </Identifiers>
      <QualitativeInputs>
        <IndustryDetails>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
        </IndustryDetails>
        <InputScope>sample string 2</InputScope>
        <ProbabilityDefault>1.1</ProbabilityDefault>
        <Regions>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
        </Regions>
        <rating>sample string 1</rating>
      </QualitativeInputs>
      <QuantativeInputs>
        <carbonFootPrint>1.1</carbonFootPrint>
        <scope1Emission>1.1</scope1Emission>
        <scope2Emission>1.1</scope2Emission>
        <totalAssets>1.1</totalAssets>
        <totalSales>1.1</totalSales>
      </QuantativeInputs>
    </EntityCalculateCAEScenarioInput>
    <EntityCalculateCAEScenarioInput>
      <Identifiers>
        <AsOfDate>2026-06-05T14:54:08.000564+00:00</AsOfDate>
        <CarbonEmissionDate>2026-06-05T14:54:08.000564+00:00</CarbonEmissionDate>
        <EntityIdentifier>sample string 2</EntityIdentifier>
        <EntityName>sample string 1</EntityName>
        <FinancialStatementDate>2026-06-05T14:54:08.000564+00:00</FinancialStatementDate>
      </Identifiers>
      <QualitativeInputs>
        <IndustryDetails>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
        </IndustryDetails>
        <InputScope>sample string 2</InputScope>
        <ProbabilityDefault>1.1</ProbabilityDefault>
        <Regions>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
        </Regions>
        <rating>sample string 1</rating>
      </QualitativeInputs>
      <QuantativeInputs>
        <carbonFootPrint>1.1</carbonFootPrint>
        <scope1Emission>1.1</scope1Emission>
        <scope2Emission>1.1</scope2Emission>
        <totalAssets>1.1</totalAssets>
        <totalSales>1.1</totalSales>
      </QuantativeInputs>
    </EntityCalculateCAEScenarioInput>
    <EntityCalculateCAEScenarioInput>
      <Identifiers>
        <AsOfDate>2026-06-05T14:54:08.000564+00:00</AsOfDate>
        <CarbonEmissionDate>2026-06-05T14:54:08.000564+00:00</CarbonEmissionDate>
        <EntityIdentifier>sample string 2</EntityIdentifier>
        <EntityName>sample string 1</EntityName>
        <FinancialStatementDate>2026-06-05T14:54:08.000564+00:00</FinancialStatementDate>
      </Identifiers>
      <QualitativeInputs>
        <IndustryDetails>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
          <EntityCalculateCAEScenarioInput.Industry>
            <IndustryCode>sample string 2</IndustryCode>
            <IndustryType>sample string 1</IndustryType>
            <IndustryWeight>3.1</IndustryWeight>
          </EntityCalculateCAEScenarioInput.Industry>
        </IndustryDetails>
        <InputScope>sample string 2</InputScope>
        <ProbabilityDefault>1.1</ProbabilityDefault>
        <Regions>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
          <EntityCalculateCAEScenarioInput.Region>
            <RegionName>sample string 1</RegionName>
            <RegionWeight>2.1</RegionWeight>
          </EntityCalculateCAEScenarioInput.Region>
        </Regions>
        <rating>sample string 1</rating>
      </QualitativeInputs>
      <QuantativeInputs>
        <carbonFootPrint>1.1</carbonFootPrint>
        <scope1Emission>1.1</scope1Emission>
        <scope2Emission>1.1</scope2Emission>
        <totalAssets>1.1</totalAssets>
        <totalSales>1.1</totalSales>
      </QuantativeInputs>
    </EntityCalculateCAEScenarioInput>
  </EntityInputs>
  <ExpectPath>
    <CAEExpectPath>
      <EPEP>3.1</EPEP>
      <EPLP>4.1</EPLP>
      <EPNP>5.1</EPNP>
      <EPNoDamPrice>2</EPNoDamPrice>
      <LPEP>7.1</LPEP>
      <LPLP>8.1</LPLP>
      <LPNP>9.1</LPNP>
      <LPNoDamPrice>6</LPNoDamPrice>
      <NPEP>11.1</NPEP>
      <NPLP>12.1</NPLP>
      <NPNP>13.1</NPNP>
      <NPNoDamPrice>10</NPNoDamPrice>
      <year>1</year>
    </CAEExpectPath>
    <CAEExpectPath>
      <EPEP>3.1</EPEP>
      <EPLP>4.1</EPLP>
      <EPNP>5.1</EPNP>
      <EPNoDamPrice>2</EPNoDamPrice>
      <LPEP>7.1</LPEP>
      <LPLP>8.1</LPLP>
      <LPNP>9.1</LPNP>
      <LPNoDamPrice>6</LPNoDamPrice>
      <NPEP>11.1</NPEP>
      <NPLP>12.1</NPLP>
      <NPNP>13.1</NPNP>
      <NPNoDamPrice>10</NPNoDamPrice>
      <year>1</year>
    </CAEExpectPath>
    <CAEExpectPath>
      <EPEP>3.1</EPEP>
      <EPLP>4.1</EPLP>
      <EPNP>5.1</EPNP>
      <EPNoDamPrice>2</EPNoDamPrice>
      <LPEP>7.1</LPEP>
      <LPLP>8.1</LPLP>
      <LPNP>9.1</LPNP>
      <LPNoDamPrice>6</LPNoDamPrice>
      <NPEP>11.1</NPEP>
      <NPLP>12.1</NPLP>
      <NPNP>13.1</NPNP>
      <NPNoDamPrice>10</NPNoDamPrice>
      <year>1</year>
    </CAEExpectPath>
  </ExpectPath>
  <Physical>false</Physical>
  <PhysicalScore>
    <CAEPhysicalScore>
      <identifier>sample string 1</identifier>
      <totalscore427>2</totalscore427>
    </CAEPhysicalScore>
    <CAEPhysicalScore>
      <identifier>sample string 1</identifier>
      <totalscore427>2</totalscore427>
    </CAEPhysicalScore>
    <CAEPhysicalScore>
      <identifier>sample string 1</identifier>
      <totalscore427>2</totalscore427>
    </CAEPhysicalScore>
  </PhysicalScore>
  <ResultDetailMain>false</ResultDetailMain>
  <ResultDetailTransition>false</ResultDetailTransition>
  <SoverignScore>
    <CAESoverignScore>
      <ISO3>sample string 1</ISO3>
      <SovereignScore>2</SovereignScore>
    </CAESoverignScore>
    <CAESoverignScore>
      <ISO3>sample string 1</ISO3>
      <SovereignScore>2</SovereignScore>
    </CAESoverignScore>
    <CAESoverignScore>
      <ISO3>sample string 1</ISO3>
      <SovereignScore>2</SovereignScore>
    </CAESoverignScore>
  </SoverignScore>
  <SwitchPer>3.1</SwitchPer>
  <Transition>false</Transition>
  <scenariosCategory>sample string 5</scenariosCategory>
</ScenarioInputs>

Parameter Information

Parameter Name: request

Property	Type	Description
EntityInputs	List`1
PhysicalScore	List`1
ExpectPath	List`1
DiscountPath	List`1
SoverignScore	List`1
DamagePath	List`1
Physical	Boolean
Transition	Boolean
SwitchPer	Double
DiscountYearly	Double
scenariosCategory	String
ResultDetailMain	Boolean
ResultDetailTransition	Boolean

Response Information

Response body formats

application/json, text/json

Sample:

{
  "svc_ret_status": 1,
  "svc_req_id": "sample string 2",
  "svc_ret_msg": "sample string 3",
  "svc_ret_data": null
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.