ESG - Update Demand Signal

Service:

Environmental Credit Service

API Version:

1.0

Update the demand signal for the ESG reporting period.

PATCH https://api.ecs.mcfs.microsoft.com/trial/v1/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}

URI Parameters

Name	In	Required	Type	Description
esgMilestoneId	path	True	string uuid	ESG Milestone Id.
esgReportingPeriodId	path	True	string uuid	ESG reporting Period Id.
esgScorecardId	path	True	string uuid	ESG Scorecard Id.

Request Body

Media Types: "application/json-patch+json", "application/json", "application/*+json"

Name	Required	Type	Description
offsetPreferences	True	ESGDemandSignal

Responses

Name	Type	Description
200 OK	ESGReportingPeriod	Success
201 Created		Returns the updated item.
400 Bad Request		Validation failure.

Security

Bearer

Definitions

Name	Description
DurabilityRating
EmissionCategory
EmissionScope
ESGDemandSignal
ESGReportedEmission
ESGReportingPeriod
ESGReportingPeriodPatchRequest	ESG Reporting Period Patch Request.
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

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[]

ESGReportingPeriodPatchRequest

ESG Reporting Period Patch Request.

Name	Type	Description
offsetPreferences	ESGDemandSignal

ResourceStatus

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