command

Edit Command

Edit the provided command

put/command/{commandId}

Path parameters

commandIdinteger required

The Command Id to Edit

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 2 of the 52 revisions of this API.31

  • 41c04de98ec511See the full diff
    • added required request body

      request-body-added-required

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

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the request body

      request-body-removed

    • removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog