Skip to main content
PATCH
/
v1
/
entities
/
{entityId}
/
commands
/
{commandId}
Cancel a Command
curl --request PATCH \
  --url https://api.traxes.io/connect/v1/entities/{entityId}/commands/{commandId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  },
  "verification": {
    "status": "Pending",
    "completedAt": "2023-11-07T05:31:56Z",
    "error": {
      "title": "<string>",
      "description": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
entityId
string<uuid>
required

The id of the Entity

​
commandId
string<uuid>
required

The id of the Command

Response

200 - application/json

OK

A command.

​
entityId
string<uuid> | null

The id of the entity.

​
id
string<uuid>

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<date-time>

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.

​
verification
object

Represents the verification state of a command.