*getActionList

Configuration Article | CA-20220907-TP-38

VDG Sense | API | Functions | Macros

1 Request
2 Response
3 Changelog

Note: This function requires an API license.

Retrieve a list of actions that can be executed with the command executeAction.

Request

command=getActionList

Response

<result errorcode="0">
  <actions count="&#91;number&#93;">
    <action>
      <name>[string]</name>
      <description>[string]</description>
      <type>[string]</type>
      <parameters count="&#91;number&#93;">
        <parameter>
          <name>[string]</name>
          <description>[string]</description>
          <type>[string]</type>
          <required>[boolean]</required>
          <min>[string]</min>
          <max>[string]</max>
          <default>[string]</default>
        </parameter>
        ...
      </parameters>
    </action>
    ...
  </actions>
</result>

node	value	remarks

node	value	remarks
/result
@errorcode	[number]	See error codes below
/result/actions
@count	[number]	The number of actions in this list.
/result/actions/action
name	[string]	unique name of the action.
description	[string]	a description of the action.
type	[string]	if it is a 'viewer' or 'server' action.
/result/actions/action/parameters
@count	[number]	the number of parameters in this list
/result/actions/action/parameters/parameter
name	[string]	unique name of the parameter.
description	[string]	a description of the parameter.
type	[string]	the type of the parameter.
required	[boolean]	[0	1	false	true	yes	no] whether this parameter is required.
min	[string]	optional, the minimum value for this parameter.
max	[string]	optional, the maximum value for this parameter.
default	[string]	optional, the default value for this parameter.

error code	description	remarks

error code	description	remarks
0	Ok	Ok, no error
-18	General error	An undefined error occured

Changelog

2.2.1 – added