command

Command Search

Changed on

Search this users Commands

get/command

Request

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

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.

sortBy'commandId' | 'command' | 'code' | 'description' | 'availableOn' | 'createAlertOn' | 'groupsWithPermissions'

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.

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

  • 9136e3c2cb1dRevision changes
    • info

      added the new enum value availableOn to the query request parameter sortBy

    • info

      added the new enum value createAlertOn to the query request parameter sortBy