Server API Reference
Server applications and command-line scripts can communicate directly with a ConcourseConnect server to perform operations like:
- Single Single On
- Batch loading of data
- Batch updates
- Queries for data export and reports
This is a low-level API and requires complete security.
Transactions sent as part of the XML packet are processed by the server and the required action is performed. Each transaction is made up of an action with a corresponding object to perform the action on.
1. XML Actions
The Client can specify one of the following actions to perform on the object:
- insert: Inserts the specified object in the database
- update: Updates the specified object in the database
- delete: Deletes the specified object from the database
- select: Queries the specified object type in the database; a list of objects can be returned, as well as a subset based on criteria
- getDateTime: returns the server's date/time
- backup: performs a deep backup of an object
- restore: performs a restore of an object that was previously backed up
2. XML Objects
Each object has a list of properties that can be set, depending on the action. The API Dictionary specifies the objects that can be accessed through the XML API. In the mapping table, the id attribute is the name used to access the object. Each object has a list of properties that can be set. Some of the properties reference other objects.
Sign in to add your comment.