Next Topic

Previous Topic

Book Contents

VSA API Web Service Summary

The VSA API Web Service provides a generalized interface for a client to programmatically interface to the VSA. This API facilitates a client being able to interface a third party package. The API focuses on the following services:

  • Connect - This service facilitates the consumer of the API to authenticate and receive a GUID to use throughout the communication. This GUID ages off similarly to how users age off.
  • Incidents - This service provides basic facilities for the user to be notified of new tickets. This facility allows users to update fields on a ticket.
  • Alarms - This service provides basic facilities for the user to be notified of new alarms and mark an alarms as closed.
  • Machines - This service provides a request to collect a set of data about one or more machines.