Passer au contenu 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
}

Autorisations

​
x-api-key
string
header
requis

Clé API par tenant. Le tenant est déterminé à partir de la clé — jamais à partir de la requête.

Paramètres de chemin

​
clusterId
string
requis

Corps

application/json
​
startTime
string<date-time>
requis

Horodatage UTC ISO-8601. Obligatoire.

Exemple:

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

​
endTime
string<date-time>
requis

Horodatage UTC ISO-8601. Doit être postérieur à startTime et dans le futur. Obligatoire.

Exemple:

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

​
limitKw
number<float>
requis

Limite de puissance en kW. Doit être supérieure à 0. Obligatoire.

Exemple:

50

​
priority
integer
défaut:0

Niveau de priorité dans le style de la pile OCPP, de 0 (la plus basse) à 10 (la plus haute). Soumettre un profil à une priorité qui existe déjà pour cette cible le remplace.

Plage requise: 0 <= x <= 10
Exemple:

5

Réponse

Planning appliqué à au moins un site

​
clusterId
string
Exemple:

"clst_20260612_a1b2c3d4"

​
applied
object[]
​
errors
object[]
​
totalLocations
integer
Exemple:

2