List Vehicle Command Executions

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/command-executions \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "vehicleId": "<string>",
      "id": "<string>",
      "commandArguments": {},
      "timeout": 123,
      "executedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Vehicle Command Executions

List Vehicle Command Executions

Retrieve a paginated list of vehicle command executions for specific vehicle based on its unique identifier (ID).

Parameters:

vehicle_id: The unique identifier (ID) of the vehicle to retrieve the command executions.

Returns:

A paginated response containing a list of vehicle command executions.

Find details on list filter syntax in our documentation here.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

AUTHENTICATION_ERROR
PAGE_SIZE_TOO_LARGE
PAGINATED_QUERY_FILTER_CHANGED
REQUEST_VALIDATION_ERROR
RESOURCE_NOT_FOUND
SERVER_ERROR

GET

vehicles

{vehicle_id}

command-executions

List Vehicle Command Executions

curl --request GET \
  --url https://api.volteras.com/v1/vehicles/{vehicle_id}/command-executions \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "vehicleId": "<string>",
      "id": "<string>",
      "commandArguments": {},
      "timeout": 123,
      "executedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextPageToken": "<string>",
  "totalResults": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

vehicle_id

string

required

Unique internal identifier for the vehicle.

Query Parameters

maxPageSize

integer

Max size of the returned list.

pageToken

string | null

Page token used for pagination.

filter

string | null

Listing filter schema.

Response

200 - application/json

Successful Response

results

VehicleCommandExecution · object[]

required

Returned data from the listing query.

Show child attributes

nextPageToken

string | null

required

Next page token used for pagination.

totalResults

integer

required

Total result count.

Get Vehicle State Of Health Get Vehicle Command Execution

⌘I

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response