List Commands

Request

URI

GET

https://http://localhost:3000/api/devices/commands

COPY

Path Parameters

string

device_id

Optional

Device Id.

string

name

Optional

Command Name.

string of array

status

Optional

List of Command status. Supported status are PENDING/EXECUTED/FAILED.

string

command

Optional

Command type.

string

command_id

Optional

Command ID.

integer

page.number

Optional

page number.

integer

page.size

Optional

page size.

string

page.sort

Optional

page.sort

Responses

200

Returns devicemgmtListCommandResponse of type(s) */*

{
    "commands": [
        {
            "status": "string",
            "name": "string",
            "lastUpdatedTime": "string",
            "asRoot": "boolean",
            "response": "string",
            "command": "string",
            "arguments": [
                {
                    "type": "string",
                    "name": "string",
                    "value": [
                        "string"
                    ]
                }
            ],
            "createdTime": "string",
            "clientId": "string",
            "commandId": "string",
            "execPath": "string",
            "deviceId": "string"
        }
    ],
    "pageInfo": {
        "totalPages": "string",
        "totalElements": "string",
        "page": "integer",
        "pageSize": "integer"
    }
}

array of devicemgmtCommand

commands

Optional

commands

commonPageResponse

pageInfo

Optional

pageInfo

404

Not Found

Operation doesn't return any data structure

On This Page