ESG - Get All ESG Reporting Periods

Service:

Environmental Credit Service

API Version:

1.0

Fetch all ESG Reporting Periods.

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

With optional parameters:

GET https://api.ecs.mcfs.microsoft.com/trial/v1/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods?id={id}&top={top}&skip={skip}&minCreatedAt={minCreatedAt}&maxCreatedAt={maxCreatedAt}&minLastModifiedAt={minLastModifiedAt}&maxLastModifiedAt={maxLastModifiedAt}&filter={filter}

URI Parameters

Name	In	Required	Type	Description
esgMilestoneId	path	True	string uuid	ESG Milestone Id.
esgScorecardId	path	True	string uuid	ESG ScoreCard Id.
filter	query		string
id	query		array
maxCreatedAt	query		string date-time
maxLastModifiedAt	query		string date-time
minCreatedAt	query		string date-time
minLastModifiedAt	query		string date-time
skip	query		integer int32
top	query		integer int32

Responses

Name	Type	Description
200 OK	ESGReportingPeriod[]	Success

Security

Bearer

Definitions

Name	Description
DurabilityRating
EmissionCategory
EmissionScope
ESGDemandSignal
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

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