ESG - Create ESG Milestone
Create a new ESG Milestone.
POST https://api.ecs.mcfs.microsoft.com/trial/v1/esgs/{esgScorecardId}/milestonesURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
esg
|
path | True |
string uuid |
ESG Scorecard Id. |
Request Body
Media Types: "application/json-patch+json", "application/json", "application/*+json"
| Name | Required | Type | Description |
|---|---|---|---|
| description | True |
string |
Gets or sets description of ESG Milestone Request. |
| endDate | True |
string |
Gets or sets the end date of the ESG Milestone Request. |
| name | True |
string |
Gets or sets Name of ESG Milestone Request. |
| startDate | True |
string |
Gets or sets the start date of the ESG Milestone Request. |
| targetEmissionReduction | True |
number |
Gets or sets target emission reduction amount in either % or mtCO2e for the ESG Milestone Request. |
| targetEmissionReductionType | True |
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 | |
|
ESGMilestone |
ESG Milestone Request Model. |
|
ESGMilestone |
|
|
ESGReported |
|
|
ESGReporting |
|
|
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 |
ESGMilestoneRequest
ESG Milestone Request Model.
| Name | Type | Description |
|---|---|---|
| description |
string |
Gets or sets description of ESG Milestone Request. |
| endDate |
string |
Gets or sets the end date of the ESG Milestone Request. |
| name |
string |
Gets or sets Name of ESG Milestone Request. |
| startDate |
string |
Gets or sets the start date of the ESG Milestone Request. |
| targetEmissionReduction |
number |
Gets or sets target emission reduction amount in either % or mtCO2e for the ESG Milestone Request. |
| targetEmissionReductionType |
ESGMilestoneTargetEmissionReductionType
| Name | Type | Description |
|---|---|---|
| Absolute |
string |
|
| Percentage |
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[] |
ResourceStatus
| Name | Type | Description |
|---|---|---|
| Approved |
string |
|
| Draft |
string |
|
| Rejected |
string |
|
| Resubmitted |
string |
|
| ReturnedForEdits |
string |
|
| Submitted |
string |