Product

Get resource forecasted demands

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource

Query parameters
organizationIdinteger · int32Required

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
200

The forecasted demands for the resource

application/json
get
/api/product/resource/{resourceId}/forecasted-demands

Get flexibility orders

get

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

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

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
200

List of flexibility orders

application/json
get
/api/product/order/flexibility

Get resource availability orders

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Query parameters
organizationIdinteger · int32Required

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
200

List of availability orders

application/json
get
/api/product/order/availability/resource/{resourceId}

Get resource availability schedule orders

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

Responses
200

List of availability schedule orders

application/json
get
/api/product/order/availabilityschedule/resource/{resourceId}

Get flexibility transactions

get

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

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

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
200

List of flexibility transactions

application/json
get
/api/product/transaction/flexibility

Get flexibility transactions affecting substation

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
substationIdinteger · int32Required

The identifier of the substation.

Query parameters
organizationIdinteger · int32Required

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
200

List of flexibility transactions affecting the substation

application/json
get
/api/product/transaction/flexibility/affecting/substation/{substationId}

Get availability transactions

get

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

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

marketZoneIdinteger · int32Required

The identifier of the market zone.

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
200

List of availability transactions

application/json
get
/api/product/transaction/availability

Get availability offers

get

Required permissions: Order.Organization.Read Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Query parameters
organizationIdinteger · int32Required

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
200

List of availability offers

application/json
get
/api/product/offer/availability/resource/{resourceId}

Create availability offers

post

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Body
Responses
200

List of availability offers

application/json
post
/api/product/offer/availability/resource/{resourceId}

Update availability offers

put

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Body
Responses
200

List of availability offers

application/json
put
/api/product/offer/availability/resource/{resourceId}

Delete availability offers

delete

Required permissions: Order.Organization.ReadWrite Required features: ResourceManagement

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Path parameters
resourceIdinteger · int32Required

The identifier of the resource.

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

availabilityOrderIdinteger · int64[]Required

The identifiers of the availability orders

Responses
delete
/api/product/offer/availability/resource/{resourceId}

No content

Get cleared availability offers

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

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
200

List of availability offers

application/json
get
/api/product/offer/availability/cleared

Get cleared availability schedule offers

get

Required permissions: Order.Organization.Read Required features: DecisionSupport

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

Responses
200

List of availability schedule offers

application/json
get
/api/product/offer/availabilityschedule/cleared

Get settlement specification

get

Required permissions: Order.Organization.Read Required features: Settlements

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

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
200

The settlement specification

application/json
get
/api/product/settlement/specification

Get settlement specification for schedules

get

Required permissions: Order.Organization.Read Required features: Settlements

Authorizations
HTTPRequired

Please provide your valid JWT bearer token in the text input below

Query parameters
organizationIdinteger · int32Required

The identifier of the organization.

Responses
200

The settlement specification for schedules

application/json
get
/api/product/settlement/schedule/specification

Last updated

Was this helpful?