command

Search Commands by ID

Changed on

Get the Command object specified by the provided commandId

get/command/{commandId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/command/{commandId}
  • Auth
    none declared

Path parameters

commandIdinteger required

Numeric ID of the Command to get

Response

successful operation

commandIdinteger

Command Id

commandstring

Command Name

codestring

Unique Code

descriptionstring

Description

userIdinteger

User Id

commandStringstring

Command String

validationStringstring

Validation String

displayProfileIdinteger

DisplayProfileId if specific to a Display Profile

commandStringDisplayProfilestring

Command String specific to the provided DisplayProfile

validationStringDisplayProfilestring

Validation String specific to the provided DisplayProfile

availableOnstring

A comma separated list of player types this command is available on

createAlertOnstring

Define if execution of this command should create an alert on success, failure, always or never.

createAlertOnDisplayProfileunknown
groupsWithPermissionsstring

A comma separated list of groups/users with permissions to this Command

groupsWithPermissionsListstring[]

An array of groups/users with permissions to this Command

Changes