Create

post

https://developer-api.partner.mygridshare.com/api/v1/flexEvent

Create a flex event for a defined flex group. This endpoint supports the creation of flat dispatch events, events that achieve a flat power profile within a specified time frame. If multiple flex events for the same group must be scheduled, each event's triggersAt time should occur after the preceding event has ended.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

flexGroupId

string

required

ID of the flex group associated with this event.

startTime

date-time

required

Start time of the flex event.

endTime

date-time

required

End time of the flex event.

kind

string

enum

required

Type of the flex event. Currently, only 'flat' is supported.

Allowed:

power_W

number

required

Power in watts to be constantly dispatched throughout the duration of the entire event.

status

string

enum

required

Status of the flex event.

Allowed:

triggersAt

date-time

Specifies the time at which the flex event planning will trigger, sending commands to the devices. It must fall within the valid send window for the event, which is bounded by the flex group's action window and by planning for neighbouring flex events. An invalid time is rejected with a 422 whose message states the window. Omit this field to have the trigger time automatically selected by Gridshare instead.

ignoreOverlaps

boolean

Defaults to true

If false, returns an error if event overlaps with existing events. When true allows overlapping events to be scheduled.

Responses

201201 response

400400 response

401401 response

403403 response

404404 response

422422 response. The event is well formed but cannot be scheduled. The message field gives the reason.