Update the schedule of a block

curl --request PUT \
  --url https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/blocks/{blockID} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ]
}
'

{
  "end": "2023-11-12T00:00:00Z",
  "id": "11111111-1111-1111-1111-111111111111",
  "powerCapacity": [
    {
      "chargePowerCapacity": 380,
      "dischargePowerCapacity": 380,
      "ratedChargePowerCapacity": 380,
      "ratedDischargePowerCapacity": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "ratedChargePower": 1000,
  "ratedDischargePower": 1000,
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "start": "2023-11-11T00:00:00Z",
  "unitsPower": "kW"
}

blocks

Update the schedule of a block

Update the schedule of a block. The schedule is represented as signed power-time pairs in kilowatts on a left-aligned 15-minute cadence. i.e., {"power": 100, "time": "2023-11-11T14:30:00Z"} represents an instruction to discharge at 100 kW between 2023-11-11T14:30:00 and 2023-11-11T14:45:00. A block's schedule will be initialised with zero power instructions for every 15-minute window across its lifetime. Only a wholesale block can have its schedule updated in this way. The market utilisation of blocks can be monitored through the `blockMetadata` field on a virtual-asset. The supplied schedule must be compatible with the existing schedule. i.e. it must only include time-power pairs corresponding to existing time-power pairs, which can be viewed through the .../virtual-assets/{virtualAssetID}/blocks/{blockID} [get] route. If the supplied schedule would cause the projected state of energy of the virtual-asset to go beyond allowed limits, then the entire update may be rejected. The current projected state of energy and allowed limits can be monitored through the `.../virtual-assets/{virtualAssetID}/operational [get]` route. Schedule updates must be posted before gate closure for the concerned delivery period. For example, updates for the 12:15:00 to 12:30:00 trading window cannot be posted after 12:10:00 for an asset with a 5m gate closure. Schedules may be subject to validation and adjustment. If such adjustments are made, they will be visible on the `.../virtual-assets/{{virtualAssetID}}/adjustments [get]` route.

PUT

/

organisations

/

{organisationID}

/

virtual-assets

/

{virtualAssetID}

/

blocks

/

{blockID}

Update the schedule of a block

curl --request PUT \
  --url https://api.trlyr.com/organisations/{organisationID}/virtual-assets/{virtualAssetID}/blocks/{blockID} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ]
}
'

{
  "end": "2023-11-12T00:00:00Z",
  "id": "11111111-1111-1111-1111-111111111111",
  "powerCapacity": [
    {
      "chargePowerCapacity": 380,
      "dischargePowerCapacity": 380,
      "ratedChargePowerCapacity": 380,
      "ratedDischargePowerCapacity": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "ratedChargePower": 1000,
  "ratedDischargePower": 1000,
  "schedule": [
    {
      "power": 380,
      "time": "2023-11-11T14:30:00Z"
    }
  ],
  "start": "2023-11-11T00:00:00Z",
  "unitsPower": "kW"
}

Headers

Authorization

string

default:Bearer <access token value>

required

Access token

Path Parameters

organisationID

string

required

Organisation ID

virtualAssetID

string

required

Virtual Asset ID

blockID

string

required

Block ID

Body

application/json

Block update

Block update

schedule

object[]

required

Hide child attributes

schedule.power

number<float>

required

Example:

380

schedule.time

string<dateTime>

required

Example:

"2023-11-11T14:30:00Z"

Response

OK

end

string<dateTime>

Example:

"2023-11-12T00:00:00Z"

id

string<uuid>

Example:

"11111111-1111-1111-1111-111111111111"

powerCapacity

object[]

Hide child attributes

powerCapacity.chargePowerCapacity

number<float>

required

Example:

380

powerCapacity.dischargePowerCapacity

number<float>

required

Example:

380

powerCapacity.ratedChargePowerCapacity

number<float>

required

Example:

380

powerCapacity.ratedDischargePowerCapacity

number<float>

required

Example:

380

powerCapacity.time

string<dateTime>

required

Example:

"2023-11-11T14:30:00Z"

ratedChargePower

number<float>

Example:

1000

ratedDischargePower

number<float>

Example:

1000

schedule

object[]

Hide child attributes

schedule.power

number<float>

required

Example:

380

schedule.time

string<dateTime>

required

Example:

"2023-11-11T14:30:00Z"

start

string<dateTime>

Example:

"2023-11-11T00:00:00Z"

unitsPower

string

Example:

"kW"

Last modified on June 30, 2026

Get a block.Gets a selection of operational data of a block as a timeseries.

⌘I