O Data - Projections By Enrollment

  • Reference
Service:
Microsoft Cloud for Sustainability
API Version:
1.0

ProjectionsByEnrollment
Connect low-latency OData APIs to your dashboards and applications for programmatic access to emissions data. Microsoft Cloud for Sustainability API Preview Terms and Conditions apply

GET https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}/enrollments/{enrollmentId}/projections
With optional parameters: 
GET https://api.mcfs.microsoft.com/api/v1.0/instances/{instanceId}/enrollments/{enrollmentId}/projections?$apply={$apply}&$filter={$filter}&$select={$select}&$orderby={$orderby}&$expand={$expand}&$top={$top}&$skip={$skip}&$count={$count}

URI Parameters

Name In Required Type Description
enrollmentId
 path True

string

instanceId
 path True

string

uuid

Format - uuid.
$apply
 query

string

$count
 query

boolean

$expand
 query

string

$filter
 query

string

$orderby
 query

string

$select
 query

string

$skip
 query

integer

int32

Format - int32.
$top
 query

integer

int32

Format - int32.

Responses

Name Type Description
200 OK

EnrollmentProjection[]

The request has succeeded.
400 Bad Request

Error

An unexpected error response.
500 Internal Server Error

Error

An unexpected error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

subscription-key

Type: apiKey
In: query

Definitions

Name Description
EnrollmentProjection
Error

EnrollmentProjection

Name Type Description
actualEmissions

number

actualUsage

number

dateKey

integer

enrollmentId

string

projectedEmissions

number

projectedUsage

number

Error

Name Type Description
code

integer

message

string