GET
Retrieves an SVC MCU. 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
| Status |
Representation |
Description |
| 200 |
application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
|
Information successfully retrieved |
| 304 |
|
MCU information has not changed since the last search.
Note: The API client must provide the "plcm-svc-mcu" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.
If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.
The "plcm-svc-mcu" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
|
| 403 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Unable to get permission. DMA roles required: Administrator
|
| 404 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
No such MCU. |
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
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
|