> ## Documentation Index > Fetch the complete documentation index at: https://docs.trlyr.com/llms.txt > Use this file to discover all available pages before exploring further. # Gets schedule adjustments for a virtual asset within a time range. > Gets a list of schedule adjustments for a virtual asset within a specified time range. Returns a JSON representation of schedule adjustments, including the delivery timestamp, accepted schedule, adjusted schedule value, and the reason for the intervention. This endpoint provides detailed information about when and why schedule adjustments were made to a virtual asset's power schedule. Only delivery periods where a schedule was adjusted will return a value, ensuring you only see actual adjustments. ## Path Parameters - `organisationID` (required): The organisation ID owning the virtual asset - `virtualAssetID` (required): The virtual asset ID for which to retrieve adjustments ## Query Parameters - `start` (required): The start time for the query range in ISO 8601 format, e.g. `2025-07-11T22:00:00Z` - `end` (required): The end time for the query range in ISO 8601 format, e.g. `2025-07-11T23:00:00Z` ## Response Format The response contains an array of adjustment points, each with: - `timestamp`: The delivery start timestamp - `acceptedSchedule`: The originally accepted schedule value in kW - `adjustedSchedule`: The adjusted schedule value in kW - `reason`: The reason for the adjustment (e.g., "STATE_OF_ENERGY_BOUNDARIES", "AVAILABILITY", etc.) ## Example Response ```json { "adjustments": [ { "timestamp": "2025-07-11T22:15:00Z", "acceptedSchedule": 480.0, "adjustedSchedule": 380.0, "reason": "STATE_OF_ENERGY_BOUNDARIES" }, { "timestamp": "2025-07-11T22:30:00Z", "acceptedSchedule": 520.0, "adjustedSchedule": 420.0, "reason": "STATE_OF_ENERGY_BOUNDARIES" } ] } ``` ## Related Endpoints - [Virtual Asset Operational Data](/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational) - Get general operational data including accepted and adjusted schedules - [Latest Virtual Asset Operational Data](/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational/latest) - Get the most recent operational data values ## OpenAPI ````yaml https://api.sandbox.trlyr.com/docs/doc.json get /organisations/{organisationID}/virtual-assets/{virtualAssetID}/adjustments openapi: 3.1.0 info: description: > This API allows clients to manage virtual-assets and blocks on the terralayr system. A virtual asset is a virtual battery, it has static parameters that dictate how much power it can import / export, how much energy it can store, and how efficiently it charges / discharges. It also has a state of charge which changes as the virtual asset exports and imports power. A block represents a slice of the power capacity of a virtual asset over time, and has a schedule which can be updated to control what the virtual-asset will do. Virtual assets should be kept balanced: you should manage the schedule such that the such that state of charge at the end of its lifetime is 50%. It is possible to submit schedules that do not end at 50%, but the response will include information about how much imbalance is left. ### Authorization All the underneath requests require a Bearer-type `Authorization` Header i.e. in the form : `Authorization: Bearer `. To retrieve a valid token you must log in to our system using a password-username authentication as follows: ``` POST https://api.sandbox.trlyr.com/auth/public/authenticate ``` with the following JSON body: ``` { "username": "YOUR_USERNAME", "password": "YOUR_PASSWORD" } ``` Your username and password are the ones you created after receiving an invitation to join your organisation. You should receive a JSON response body from which you can extract your token under `access_token`. If you have any questions, don't hesitate to contact our account manager at the following address: support@trlyr.com. title: terralayr API version: 1.11.3 servers: - description: Production API url: https://api.trlyr.com - description: Sandbox API url: https://api.sandbox.trlyr.com security: [] tags: - name: virtual-assets - name: afrr - name: fcr - name: ancillary - name: blocks externalDocs: description: '' url: '' paths: /organisations/{organisationID}/virtual-assets/{virtualAssetID}/adjustments: get: tags: - virtual-assets summary: Gets schedule adjustments for a virtual asset within a time range. description: > Gets a list of schedule adjustments for a virtual asset within a specified time range. Returns a JSON representation of schedule adjustments, including the delivery timestamp, accepted schedule, adjusted schedule value, and the reason for the intervention. This endpoint provides detailed information about when and why schedule adjustments were made to a virtual asset's power schedule. Only delivery periods where a schedule was adjusted will return a value, ensuring you only see actual adjustments. ## Path Parameters - `organisationID` (required): The organisation ID owning the virtual asset - `virtualAssetID` (required): The virtual asset ID for which to retrieve adjustments ## Query Parameters - `start` (required): The start time for the query range in ISO 8601 format, e.g. `2025-07-11T22:00:00Z` - `end` (required): The end time for the query range in ISO 8601 format, e.g. `2025-07-11T23:00:00Z` ## Response Format The response contains an array of adjustment points, each with: - `timestamp`: The delivery start timestamp - `acceptedSchedule`: The originally accepted schedule value in kW - `adjustedSchedule`: The adjusted schedule value in kW - `reason`: The reason for the adjustment (e.g., "STATE_OF_ENERGY_BOUNDARIES", "AVAILABILITY", etc.) ## Example Response ```json { "adjustments": [ { "timestamp": "2025-07-11T22:15:00Z", "acceptedSchedule": 480.0, "adjustedSchedule": 380.0, "reason": "STATE_OF_ENERGY_BOUNDARIES" }, { "timestamp": "2025-07-11T22:30:00Z", "acceptedSchedule": 520.0, "adjustedSchedule": 420.0, "reason": "STATE_OF_ENERGY_BOUNDARIES" } ] } ``` ## Related Endpoints - [Virtual Asset Operational Data](/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational) - Get general operational data including accepted and adjusted schedules - [Latest Virtual Asset Operational Data](/organisations/{organisationID}/virtual-assets/{virtualAssetID}/operational/latest) - Get the most recent operational data values parameters: - description: Access token in: header name: Authorization required: true schema: default: Bearer type: string - description: Organisation ID in: path name: organisationID required: true schema: type: string - description: Virtual Asset ID in: path name: virtualAssetID required: true schema: type: string - description: Query start time in: query name: start required: true schema: type: string - description: Query end time in: query name: end required: true schema: type: string requestBody: content: application/json: schema: type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdjustmentsResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '500': description: Internal Server Error components: schemas: AdjustmentsResponseBody: properties: adjustments: items: $ref: '#/components/schemas/AdjustmentPointBody' type: array uniqueItems: false required: - adjustments type: object AdjustmentPointBody: properties: acceptedSchedule: example: 480 format: float type: number adjustedSchedule: example: 380 format: float type: number reason: example: STATE_OF_ENERGY_BOUNDARIES type: string timestamp: example: '2023-11-11T14:30:00Z' format: dateTime type: string required: - acceptedSchedule - adjustedSchedule - reason - timestamp type: object ````