JSON Command Tester

A convenient way to discover and explore the API, with over two dozen commands.

The JSON Command Tester is built on the scheduleCommand function, and provides cut and paste fields to try out parameters. Once you’ve found and verified the functionality you need, you can even copy and paste from here into your own code. The JSON Command Tester can be accessed from the Data Controller column in your Captivate project panel under API Examples --> API Tour.

Command

Choose the command from the Command: drop down menu. Once selected, it displays information about the specific command, including details about all parameters.

This is the first parameter of the scheduleCommand() function. The second and third parameters are JavaScript objects that carry the attributes and variables for each command, respectively.

Parameters

The parameters box sets up the JavaScript object which carries all the attributes and options available for that command. To add or change values, edit directly in this.

Note that some parameters, are automatically filled in for convenience. These include the input name and title id.

Variables

If the particular command supports a set of variables, this displays a JavaScript object to manage the variables.

For convenience, it pre-fills the JavaScript object with all the variables of the connected title with their current values.

Execute Command

Once you have chosen a command and prepared the parameters and variables, click here to execute the command.

Returned

This displays the JavaScript object that is passed to the scheduleCommand callback as a JSON string.

Notification

Some commands, such as subscribe or getSnapShot, send JavaScript objects back later, via the onNotify callback (see above).