xMatters, inc. does not publish the underlying xMatters database schema. The principle reason for this is that the database is used as an object store rather than as a relational database. This means that the database structure changes frequently and modifications to data cannot be safely done in a relational manner.
There are four published APIs to xMatters data:
- The xMatters web user interface: This is the expected standard interface for xMatters Users.
- xMatters web services: These provide a programmatic interface to xMatters data. They allow reporting on many facets of operation and allow immediate interaction with xMatters, including entering Events and modifying Users, Devices, Groups and other configuration data. For more information, refer to the "xMatters Web Services" section of the xMatters Online Developer's Guide.
- xMatters Data Synchronization: The DataSync process provides a method for querying or modifying large numbers of User, Device, and Group records in xMatters. DataSync is a batch process that will add, update, or delete xMatters objects. It also can be used to extract information for queries. This is a complex process that allows querying and modification of almost all data for these objects. For more information, refer to the "Data Synchronization" chapter of the xMatters installation and administration guide.
- Data Import: This process allows the bulk loading of a smaller number of Users (i.e., <1000) and their associated Groups. Data Import uses an Excel spreadsheet to load a simplified version of objects into xMatters. For more information, refer to the "Import Data" Section in the "System Administration" chapter of the xMatters installation and administration guide.
JDN-1153 Originally created by Don Clark