ESG - Create ESG Milestone

Service:

Environmental Credit Service

API Version:

1.0

Create a new ESG Milestone.

POST https://api.ecs.mcfs.microsoft.com/trial/v1/esgs/{esgScorecardId}/milestones

URI Parameters

Name	In	Required	Type	Description
esgScorecardId	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	ESGMilestoneTargetEmissionReductionType

Responses

Name	Type	Description
200 OK	ESGMilestone	Success
201 Created		Returns the newly created item.
400 Bad Request		Validation failure.

Security

Bearer

Definitions

Name	Description
DurabilityRating
EmissionCategory
EmissionScope
ESGDemandSignal
ESGMilestone
ESGMilestoneRequest	ESG Milestone Request Model.
ESGMilestoneTargetEmissionReductionType
ESGReportedEmission
ESGReportingPeriod
ResourceStatus

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	DurabilityRating
geospherePercentageMix	integer
natureBasedPercentage	integer
originId	string
technologyBasedPercentage	integer

ESGMilestone

Name	Type	Description
description	string
endDate	string
id	string
milestoneGoal	number
name	string
reportingPeriod	ESGReportingPeriod
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

ESGMilestoneTargetEmissionReductionType

Name	Type	Description
Absolute	string
Percentage	string

ESGReportedEmission

Name	Type	Description
category	EmissionCategory
originId	string
quantity	number
scope	EmissionScope
status	ResourceStatus

ESGReportingPeriod

Name	Type	Description
actual	number
id	string
milestoneId	string
offsetPreferences	ESGDemandSignal
offsetsApplied	number
reportedEmission	ESGReportedEmission
reportingDate	string
retiredCredits	string[]

ResourceStatus

Name	Type	Description
Approved	string
Draft	string
Rejected	string
Resubmitted	string
ReturnedForEdits	string
Submitted	string