POST /batteries/{batteryId}/operation-mode
Request an operationMode
change for a battery. This request creates an Action that will retry until the battery's operationMode
matches the expected value. The Action must complete before any further commands can be sent to the battery. Only one Action can be active for a specific battery at a time. If a new Action is created, the previous Action will be automatically cancelled and transitioned to the CANCELLED
state. Regardless of operation mode, the battery's charge limit will not fall below dischargeLimit
except in emergency power situations. Transitions can be tracked via the user:vendor-action:updated
webhook event or Get Operation Mode Action.
Servers
- https://enode-api.production.enode.io
Path parameters
Name | Type | Required | Description |
---|---|---|---|
batteryId |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
operationMode |
String | Yes |
Desired operation mode of the battery.
Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.