There are five API
operations, and they are invoked by HTTP methods.
provided using HTTP headers and HTTP body containing XML. For information on
operation uses the HTTP POST method to make one new item and return the URL of
that item in the HTTP location header. That URL can then be used to perform the
get, update, and delete operations. An XML body containing the parameters and
values for the new item must be specified.
operation uses the HTTP DELETE method to delete one item. The item may be
marked for deletion or permanently deleted depending on the item type.
To delete more than one item at a
time, refer to the Operation API.
items (those automatically created by the system, such as the
bucket interval), items referenced in scripts, or items referenced by other
The get operation
uses the HTTP GET method to retrieve one item. For example, to return one
bucket interval record, perform the get operation using the URL:
operation uses the HTTP GET method to retrieve a list of items. For example, to
retrieve a list of bucket intervals, perform the list operation using the URL:
- Summary list: Some APIs
have parameters that include a large amount of data when returned, such as
collections of references. Use this query parameter to reduce the number of
parameters returned for each item in the list. For example, in the Skill Group
API, if skill groups contain a large number of agents, a large amount of data
may be returned. Use this query option to return the basic skill group data
along with the number of agents having the skill. Append the query parameter
summary=true to the URL for the API; for example,
operation uses the HTTP PUT method to modify one item. An XML body containing
the parameters and values to update must be specified. For example, to update
the name of a bucket interval, perform the update operation on the URL
with the following body: