Saltar al contenido principal
POST
/
clusters
/
{clusterId}
/
schedules
Apply a schedule to every location in a cluster
curl --request POST \
  --url https://api.ridergy.com/v1/clusters/{clusterId}/schedules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "startTime": "2026-06-12T08:00:00Z",
  "endTime": "2026-06-12T18:00:00Z",
  "limitKw": 50,
  "priority": 5
}
'
{
  "clusterId": "clst_20260612_a1b2c3d4",
  "applied": [
    {
      "locationId": "3632155",
      "priority": 5,
      "limitKw": 50,
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "permanentLimitKw": 100,
      "effectiveLimitKw": 50
    }
  ],
  "errors": [
    {
      "locationId": "<string>",
      "error": {
        "error": {
          "code": "LOCATION_NOT_FOUND",
          "message": "Location 123 was not found for the provided tenant",
          "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  ],
  "totalLocations": 2
}

Autorizaciones

x-api-key
string
header
requerido

Clave de API por tenant. El tenant se deriva de la clave — nunca de la solicitud.

Parámetros de ruta

clusterId
string
requerido

Cuerpo

application/json
startTime
string<date-time>
requerido

Marca de tiempo UTC en formato ISO-8601. Obligatorio.

Ejemplo:

"2026-06-12T08:00:00Z"

endTime
string<date-time>
requerido

Marca de tiempo UTC en formato ISO-8601. Debe ser posterior a startTime y futura. Obligatorio.

Ejemplo:

"2026-06-12T18:00:00Z"

limitKw
number<float>
requerido

Límite de potencia en kW. Debe ser mayor que 0. Obligatorio.

Ejemplo:

50

priority
integer
predeterminado:0

Nivel de prioridad al estilo de la pila OCPP, de 0 (la más baja) a 10 (la más alta). Enviar un perfil con una prioridad que ya existe para este objetivo lo reemplaza.

Rango requerido: 0 <= x <= 10
Ejemplo:

5

Respuesta

Horario aplicado a al menos una ubicación

clusterId
string
Ejemplo:

"clst_20260612_a1b2c3d4"

applied
object[]
errors
object[]
totalLocations
integer
Ejemplo:

2