• Loading...
This documentation refers to a previously released version of BMC Atrium Discovery (other versions).

CSV API

Skip to end of metadata
Go to start of metadata
Space Search

Searching TWF 7.2

Table of Contents

The CSV API enables users to interrogate the data store using a script or program, and receive data back as a stream of CSV (comma separated values) text, an empty string, or a return code.

Usage

The CSV API is intended to be used by a script or program. It can also be accessed using a browser, or using the wget command, though these would generally be used for testing. The following section describes the parameters required and values returned when using the CSV API. The query is specified as a URL of the form:

http://appliance/ui/api/CsvApi?query=search_string&username=username&password=password

If you are using an appliance with https redirection enabled, you must use an https URL in your scripts. The redirection script changes the http request and the script will not work. To enable or disable https redirection, contact Tideway Professional Services.

https://appliance/ui/api/CsvApi?query=search_string&username=username&password=password

The URL is entered on a single line. In these examples, appliance is the resolvable hostname or IP address of the appliance, search_string is a query string as recognized by the data store, username and password are the username and password of the Tideway Foundation user.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.