Cisco Acano X-series 開発者ガイド

4.3 PUT Methods

PUT methods modify existing objects; for example, changing the name of a coSpace, muting a
specific call leg or changing the layout.

In general, when using PUT in an object:

n

omit a parameter to leave its value unchanged

n

use a parameter with a new value to change to this value. Supply an empty value to unset a
value. For example, to remove a tenant association from a coSpace, modify that coSpace
with a parameter set including “tenant=”.

4.3.1 HTTP specifics

Parameters for a request must be supplied in “x-www-form-urlencoded” format.

4.3.2 How PUT methods are detailed in this document

Each PUT method is in the same section as the POST method for the same object e.g. creating
and modifying a coSpace are dealt with together. Form parameters for modifying an object
(PUT) are only noted if they differ from the POST method; for example, for callLegs.

4.4 DELETE Methods

A DELETE method removes an individual object from the hierarchy; for example, disconnecting
a call leg or disassociating a user from a coSpace so that the user is no longer a member.

Therefore the DELETE method is typically performed at the Individual level e.g. DELETE on
/api/v1/coSpace/<id>/accessMethods/<id>

The object’s ID is known either from a previous retrieval (GET) method at the Collections level or
from the “Location” field in the response to a previous creation (PUT) method. (coSpace can be
deleted at the Collections level.)

If the object is removed successfully, the Meeting Server sends a “200 OK” response.

Because of the relative simplicity of this method, it is not detailed elsewhere in this document –
with the exception of deleting chat messages.

4.5 Failure Reasons

The following "failureDetails" codes can be returned by the API for any of the above methods,
in the form in response to a user error: