command

Edit Command

Changed on

Edit the provided command

put/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

The Command Id to Edit

Request body application/x-www-form-urlencoded

commandstring required

The Command Name

descriptionstring

A description for the command

commandStringstring

The Command String for this Command. Can be overridden on Display Settings.

validationStringstring

The Validation String for this Command. Can be overridden on Display Settings.

availableOnstring

An array of Player types this Command is available on, empty for all.

createAlertOnstring

On command execution, when should a Display alert be created? success, failure, always or never

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

  • 622fb073aecdRevision changes
    • info

      added the optional property to the response with the status

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status