Skip to Content

Introduction

The TrueSight Middleware Administrator Scripting API is provided as a RESTful interface to the TrueSight Middleware Administrator product. A JavaScript API is also provided that wraps the RESTful API, making writing JavaScript scripts that interact with the TrueSight Middleware Administrator service convenient. 

The data format used by the REST/JS API is JavaScript Object Notation (JSON), a format that is very consumable by web browsers because of JSON's basis on JavaScript. Libraries are provided in many different programming languages to help create and consume JSON content as well.

Installation

Pre-requisites

Prior to installing the JavaScript API, you must install a Java 7 runtime environment and set the JAVA_HOME environment variable appropriately. This means that the java program should be executable by issuing, on the command line:

$JAVA_HOME/bin/java on Linux

Or

%JAVA_HOME%\bin\java.exe on Windows

The REST API has no installable distribution and no specific requirements other than some way to issue HTTP requests. A popular tool for working with HTTP requests is the cURL program which can be found at http://curl.haxx.se.

Installing

To install the TrueSight Middleware Administrator JavaScript API, simply extract the compressed archive (.tar.gz on Linux and .zip on Windows) into a directory of your choice. The compressed archive containing the JavaScript API can be found in the "api" directory of your installation.

There is no specific installation for the REST API, see the Pre-requisites section above.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC TrueSight Middleware Administrator 8.0