Set a control action for a location

post https://api.amberflow.io/api/v1/locations/{location_id}/control

Create a control action for the specified location.

There are four control options:

max_grid_export: This is the maximum amount of power that can be exported, given the grid constraints.
zero_grid_export: This will limit the power export to zero.
max_grid_import: This is the maximum amount of power that can be imported, given the grid and operational constraints.

Path Params

location_id

uuid

required

Body Params

time_from

The start time of the control action. This value should be:- in the future- current quarter: any remaining exact minute (e.g. ..., 00:12, 00:13, 00:14)- upcoming quarters: exact quarter (e.g. 00:00, 00:15, 00:30, 00:45)

time_to

The end time of the control action. Should be:

in the future
later than time_from
be the start of the quarter following time_from (e.g. 00:00, 00:15, 00:30, 00:45)

type

string

required

The type of the control action:

max_grid_export: Maximize power production and export to grid.
zero_grid_export: Optimize power production and consumption for net zero export to grid.
max_grid_import: Minimize production for maximal import from grid.

value

Requested power delta in MW, only required when the control action type is "power_delta".

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.amberflow.io/api/v1/locations/location_id/control \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "max_grid_export"
8
}
9
'


xxxxxxxxxx
18
 
1
{
2
  "id": "123e4567-e89b-12d3-a456-426614174000",
3
  "created_at": "2024-06-04T12:00:000Z",
4
  "time_from": "2024-06-04T12:00:00Z",
5
  "time_to": "2024-06-04T12:15:00Z",
6
  "type": "max_grid_export",
7
  "value": null,
8
  "results": [
9
    {
10
      "power_after": 9,
11
      "power_before": 10,
12
      "power_delta": -1,
13
      "time_from": "2024-06-04T12:00:00Z",
14
      "time_to": "2024-06-04T12:15:00Z",
15
      "unit": "MW"
16
    }
17
  ]
18
}

200Successful Response

422Validation Error