API Usage and Conventions
Cisco VVB provides REST-based API functions that are accessed over HTTP(S). Five API functions are supported; each is mapped to an HTTP(S) operation.
|
API Function |
Description |
|---|---|
|
create (POST) |
Creates an object in the database and returns a response that contains the URL reference to the newly created object. |
|
delete (DELETE) |
Deletes the object. |
|
get (GET) |
Returns data for an object. |
|
update (PUT) |
Modifies an object. |
|
list (GET) |
Returns a list of objects with multiple records. |
The POST and PUT operations take a payload with an XML/JSON-based input. GET and DELETE calls do not take a payload. All output is provided as XML when there is a response other than HTTP headers.
XML is case-sensitive. When XML/JSON data is sent to the server, the tag names must match. <Name> and <name> are two different XML elements. If a payload contains duplicate fields, only one is transmitted. The duplicate fields are ignored.