GET
Retrieves an MCU on the DMA. Etag's calculation includes configuration fields only.
[tags: DMA]
Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
Note 5: The Etag's calculation includes configuration fields (as opposed to status). DMA can
modify configuration fields but cannot modify status fields.
|
Response
PUTUpdates information about an MCU. [tags: DMA]Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
|
Representations
Response
| Status |
Representation |
Description |
| 204 |
|
MCU successfully updated.
|
| 404 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
No such MCU. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Name is required. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Name must be between 1 and 32 characters in length, inclusive. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied name contains invalid characters. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied management address is invalid. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied signaling type is not a valid selection. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The SIP signaling address is missing. SIP signaling address is required when credentials (management username, password, IP)
are not provided for an MCU designated for SIP support.
|
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied SIP signaling address is invalid. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The H.323 signaling address is missing. H.323 signaling address is required when credentials (management username, password,
IP) are not provided for an MCU designated for H.323 support.
|
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied H.323 signaling address is invalid. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The media address is missing. Media address is required when credentials (management username, password, IP) are not provided. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The media address is invalid. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The media address is duplicated. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
You must supply either media addresses or credentials (user ID, password, management address) to configure an MCU. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The user ID is required. Credentials (management username, password, IP) are required when media and signaling addresses are
not provided.
|
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The password is required. Credentials (management username, password, IP) are required when media and signaling addresses
are not provided.
|
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The gateway delimiter is required. Delimiter must be provided for MCUs designated as gateways. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The supplied gateway delimiter is invalid. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
MCU name is already used. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Management IP address is already used. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Signaling IP address is already used. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
MCU name cannot be edited when there are either active calls or conferences. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
MCU name cannot be deleted when there are either active calls or conferences. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
MCU name cannot be deleted, please unregister it first. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Hosts resolve to the same address. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
If specified, the number of ports reserved for cascading must not be negative. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The override-default field was true, but the corresponding field was not specified. |
| 409 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
The override-default field was false, but the corresponding field was specified with a value other than the default. |
| 500 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
An error occurred creating a configuration editing session. |
DELETEDeletes an MCU. [tags: DMA]Request
Query Parameters
| Name |
Type |
Description |
|
|
|
| type |
xs:string |
Specifies an enumerated type that will indicate that the resource should be read by its
human-readable name or immutable, unique identifier such as a UUID, integer, etc.
The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its human-readable name. Unfortunately, the name can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.
Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name|id}
Note 2: If the "name" enumeration is specified, then the value should correspond to the name.
Otherwise, the resource cannot not be found.
Note 3: If the "id" enumeration is specified, the value should correspond to the unique
identifier. Otherwise, the resource cannot not be found.
Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter
can simply specify the unique identifier and the query parameter, "?type=id", is not required.
|
Response
|