ESG - Create ESG Scorecard
Create ESG Scorecard.
POST https://api.ecs.mcfs.microsoft.com/trial/v1/esgsRequest Body
Media Types: "application/json-patch+json", "application/json", "application/*+json"
| Name | Required | Type | Description |
|---|---|---|---|
| currentEmissionsPerYear | True |
number |
Gets or sets current emissions per year of the ESG scorecard. |
| goal | True |
number |
Gets or sets goal of the ESG scorecard. |
| goalEndDate | True |
string |
Gets or sets goal end date of the ESG scorecard. |
| goalStatement |
string |
Gets or sets goal statement of the ESG scorecard. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Success |
|
| 201 Created |
Returns the newly created item. |
|
| 400 Bad Request |
Validation failure. |
Security
Bearer
Definitions
| Name | Description |
|---|---|
|
Durability |
|
|
Emission |
|
|
Emission |
|
|
ESGDemand |
|
| ESGMilestone | |
|
ESGReported |
|
|
ESGReporting |
|
| ESGRequest |
ESG Request Model. |
|
ESGScorecard |
Service model for the ESG scorecard. |
|
Market |
|
|
Organization |
Response model for representing the basic organization information. |
|
Resource |
DurabilityRating
| Name | Type | Description |
|---|---|---|
| LongTerm |
string |
|
| MediumTerm |
string |
|
| ShortTerm |
string |
EmissionCategory
| Name | Type | Description |
|---|---|---|
| DirectFacilities |
string |
|
| DirectVehicles |
string |
|
| IndirectBusinessTravel |
string |
|
| IndirectCapitalGoods |
string |
|
| IndirectDownstreamLeasedAssets |
string |
|
| IndirectDownstreamTransportationAndDistribution |
string |
|
| IndirectEmployeeCommuting |
string |
|
| IndirectEndOfLifeTreatmentOfSoldProducts |
string |
|
| IndirectFranchises |
string |
|
| IndirectFuelAndEnergyRelatedActivities |
string |
|
| IndirectInvestments |
string |
|
| IndirectProcessingOfSoldProducts |
string |
|
| IndirectPurchasedEnergy |
string |
|
| IndirectPurchasedGoodsAndServices |
string |
|
| IndirectUpstreamLeasedAssets |
string |
|
| IndirectUpstreamTransportationAndDistribution |
string |
|
| IndirectUseOfSoldProducts |
string |
|
| IndirectWasteGeneratedInOperations |
string |
EmissionScope
| Name | Type | Description |
|---|---|---|
| One |
string |
|
| Three |
string |
|
| Two |
string |
ESGDemandSignal
| Name | Type | Description |
|---|---|---|
| biospherePercentageMix |
integer |
|
| carbonReductionPercentage |
integer |
|
| carbonRemovalPercentage |
integer |
|
| countryOrRegionPreferences |
string[] |
|
| durabilityPreference | ||
| geospherePercentageMix |
integer |
|
| natureBasedPercentage |
integer |
|
| originId |
string |
|
| technologyBasedPercentage |
integer |
ESGMilestone
| Name | Type | Description |
|---|---|---|
| description |
string |
|
| endDate |
string |
|
| id |
string |
|
| milestoneGoal |
number |
|
| name |
string |
|
| reportingPeriod | ||
| scorecardId |
string |
|
| startDate |
string |
ESGReportedEmission
| Name | Type | Description |
|---|---|---|
| category | ||
| originId |
string |
|
| quantity |
number |
|
| scope | ||
| status |
ESGReportingPeriod
| Name | Type | Description |
|---|---|---|
| actual |
number |
|
| id |
string |
|
| milestoneId |
string |
|
| offsetPreferences | ||
| offsetsApplied |
number |
|
| reportedEmission | ||
| reportingDate |
string |
|
| retiredCredits |
string[] |
ESGRequest
ESG Request Model.
| Name | Type | Description |
|---|---|---|
| currentEmissionsPerYear |
number |
Gets or sets current emissions per year of the ESG scorecard. |
| goal |
number |
Gets or sets goal of the ESG scorecard. |
| goalEndDate |
string |
Gets or sets goal end date of the ESG scorecard. |
| goalStatement |
string |
Gets or sets goal statement of the ESG scorecard. |
ESGScorecardResponse
Service model for the ESG scorecard.
| Name | Type | Description |
|---|---|---|
| currentEmissionsPerYear |
number |
Gets or sets current emissions per year of the ESG scorecard. |
| esgMilestones |
Gets or sets milestones of the ESG scorecard. |
|
| goal |
number |
Gets or sets goal of the ESG scorecard. |
| goalEndDate |
string |
Gets or sets goal end date of the ESG scorecard. |
| goalStatement |
string |
Gets or sets goal statement of the ESG scorecard. |
| id |
string |
Gets or sets ID of the ESG scorecard. |
| owner |
Response model for representing the basic organization information. |
MarketRole
| Name | Type | Description |
|---|---|---|
| Buyer |
string |
|
| IssuingRegistry |
string |
|
| Marketplace |
string |
|
| NetworkOperator |
string |
|
| Supplier |
string |
|
| ValidationAndVerificationBody |
string |
OrganizationInfoResponse
Response model for representing the basic organization information.
| Name | Type | Description |
|---|---|---|
| id |
string |
Gets or sets unique identifier of the organization. |
| marketRole | ||
| name |
string |
Gets or sets the name of the organization. |
ResourceStatus
| Name | Type | Description |
|---|---|---|
| Approved |
string |
|
| Draft |
string |
|
| Rejected |
string |
|
| Resubmitted |
string |
|
| ReturnedForEdits |
string |
|
| Submitted |
string |