Resource

Get resources

get

Required permissions: Resource.Organization.Read Required features: Grid

Query parameters
organizationIdinteger · int64Required

The identifier of the organization.

marketZoneIdinteger · int64Optional

The identifier of the market zone

Responses
chevron-right
200

List of resources

application/json
idinteger · int64Required
organizationIdinteger · int64Required
marketZoneIdinteger · int64Required
managedByOrganizationIdinteger · int64Required
createdAtstring · date-timeRequired
createdByinteger · int64Required
connectedAtstring · date-timeRequired
namestring · nullableRequired
longitudestring · nullableRequired
latitudestring · nullableRequired
typeall ofRequired

Allowed values:

0 = Consuming
1 = Producing

integer · enumOptional

Allowed values:

0 = Consuming
1 = Producing

Possible values:
regulationTypeall ofRequired

Allowed values:

0 = Up
1 = Down

integer · enumOptional

Allowed values:

0 = Up
1 = Down

Possible values:
enduranceinteger · int32 · nullableRequired
cooldowninteger · int32 · nullableRequired
useZeroReferencebooleanRequired
actualRegisterIdinteger · int64 · nullableRequired
referenceRegisterIdinteger · int64 · nullableRequired
conditionalDeliveryLimitinteger · int64Required
conditionalUseDynamicDeliveryLimitbooleanRequired
conditionalAutomaticAcknowledgementbooleanRequired
isAggregatebooleanRequired
transactionRevalidationAllowedbooleanRequired
isLimitedByForecastedDemandbooleanRequired
get
/api/grid/resource

Save resource reference readings

post

Required permissions: Planning.Organization.ReadWrite Required features: Grid

Path parameters
resourceIdinteger · int64Required

The identifier of the resource.

Body
Responses
post
/api/grid/resource/{resourceId}/readings/reference

No content

Save resource actual readings

post

Required permissions: Resource.Organization.ReadWrite Required features: Grid | DecisionSupport

Path parameters
resourceIdinteger · int64Required

The identifier of the resource.

Body
Responses
post
/api/grid/resource/{resourceId}/readings/actual

No content

Revalidate resource transactions

put

Required permissions: Resource.Organization.ReadWrite Required features: Grid | DecisionSupport

Path parameters
resourceIdinteger · int64Required

The identifier of the resource.

Query parameters
organizationIdinteger · int64Required

The identifier of the organization

startstring · date-timeRequired

The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

endstring · date-timeRequired

The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

Responses
put
/api/grid/resource/{resourceId}/transactions/revalidate

No content

Last updated

Was this helpful?