There are five API operations, and they are invoked by HTTP methods.
Responses are provided using HTTP headers and HTTP body containing XML. For information on XML, see XML.
The create 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.
The delete 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 (Operation API).
You cannot delete BuiltIn items (those automatically created by the system, such as the BuiltIn bucket interval), items referenced in scripts, or items referenced by other items.
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: https://<server>/unifiedconfig/config/bucketinterval/<id> .
The list 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: https://<server>:<serverport>/unifiedconfig/config/bucketinterval. See also Permissions, Pagination, Search, and Sort.
The update 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 https://<server>:<serverport>/unifiedconfig/config/bucketinterval/(id) with the following body:
<bucketInterval> <name>newName</name> <changeStamp>0</changeStamp> </bucketInterval>