Sign in
command

Search Commands by ID

Get the Command object specified by the provided commandId

get/command/{commandId}

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.

{"stackTrail":"components:schemas:Command:properties:createAlertOnDisplayProfile","oasType":"schema","type":"unknown","description":"Create Alert On specific to the provided DisplayProfile."}
groupsWithPermissionsstring

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

Changes

Changed in 1 of the 52 revisions of this API.1