command

Command Search

Search this users Commands

get/command

Query parameters

commandIdinteger

Filter by Command Id

commandstring

Filter by Command Name

codestring

Filter by Command Code

useRegexForNameinteger

Flag (0,1). When filtering by multiple commands in command filter, should we use regex?

useRegexForCodeinteger

Flag (0,1). When filtering by multiple codes in code filter, should we use regex?

logicalOperatorNamestring

When filtering by multiple commands in command filter, which logical operator should be used? AND|OR

logicalOperatorCodestring

When filtering by multiple codes in code filter, which logical operator should be used? AND|OR

typestring

Filter by player type (e.g. android, windows, linux, chromeOS, lg). Returns commands available on that type plus commands with no type restriction.

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

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

Aug 20, 20269136e3c2cb1d2See the full diff
- ○
  added the new enum value availableOn to the query request parameter sortBy
  request-parameter-enum-value-added
- ○
  added the new enum value createAlertOn to the query request parameter sortBy
  request-parameter-enum-value-added
Jul 30, 2026fe497e811c7f3See the full diff
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortDir
  new-optional-request-parameter
- ○
  added the new optional query request parameter type
  new-optional-request-parameter
Feb 25, 202641c04de98ec51See the full diff
- ○
  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
Jan 30, 202502a47f5c63451See the full diff
- ○
  endpoint added
  endpoint-added
Mar 8, 20247a6678dd43b41See the full diff
- ▲
  api removed without deprecation
  api-removed-without-deprecation
Aug 21, 2023fa67664926f91See the full diff
- ○
  added the new optional query request parameter commandLike
  new-optional-request-parameter
Feb 17, 20208e127539510414See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ●
  deleted the query request parameter logicalOperatorCode
  request-parameter-removed
- ●
  deleted the query request parameter logicalOperatorName
  request-parameter-removed
- ●
  deleted the query request parameter useRegexForCode
  request-parameter-removed
- ●
  deleted the query request parameter useRegexForName
  request-parameter-removed
This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history