ConcourseSuite Community Edition

Core Team

PUBLIC PROFILE

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.

2. XML Objects

Each object has a list of properties that can be set, depending on the action. The mapping table shown below 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(fields) reference other tables.

The attributes of a property(field) include:
1. name: The name of the property that can be set
2. alias: Typically used with mapping the client's primary key to the server's. If an alias called 'guid' is used, then the client's primary key will be compared to the server's primary key. This is essentially used when a client has to perform synchronization with the server. For more information on the Sync Protocol and Sync API, refer to the Client - Server Synchronization section.
3. type: The expected value type of the property
4. lookup: Typically used with mapping the client's primary key to the server's; If a lookup attribute is specified then the value will be looked up in the client-server mapping before the operation is performed.

3. XML Object Mapping

The following modules have support for querying objects through the API. Click on a particular module below to see a list of Objects that belong to the module and the properties that can be specified for each object via the API.