POST
/
v1
/
entities
/
{entityId}
/
commands
curl --request POST \
  --url https://platform.realto.io/api/v1/entities/{entityId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "value": "<string>"
}'
{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "Canceled",
  "triggerTime": "2023-11-07T05:31:56Z",
  "type": "Disconnect",
  "value": "<string>",
  "error": {
    "title": "<string>",
    "description": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
entityId
string
required

The id of the Entity

Query Parameters

​
ignoreCooldown
boolean
default:false

Ignore internal cooldowns of the Entity. Using this may result in Commands not being executed!

Body

The Command to send

A command.

​
type
string | null

The type of the command.

​
value
string | null

The value for the command.

Response

201 - application/json
Created

A command.

​
entityId
string | null

The id of the entity.

​
id
string

The id of the command.

​
status
enum<string>

Represents the different states of a command.

Available options:
Canceled,
Failed,
Pending,
Sent,
Succeeded,
Triggered
​
triggerTime
string

The trigger time of command.

​
type
enum<string>

Represents the available command types

Available options:
Disconnect,
LimitFeedIn,
Reset,
StartCharging,
StopCharging,
StopFeedIn
​
value
string | null

The value for the issued command.

​
error
object

Represents an error that occurred when command is validated or sent.

Was this page helpful?