NetworkDevice



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/network-device

Summary


Resources Methods
https://localhost:8443/api/rest/network-device

https://localhost:8443/api/rest/network-device/dmas

GET Retrieves all dmas information.

POST  Add a DMA.

https://localhost:8443/api/rest/network-device/dmas/{device-uuid}

DELETE  Deletes information about a DMA [tags: RPRM] .

Resources


https://localhost:8443/api/rest/network-device


https://localhost:8443/api/rest/network-device/dmas


Methods

GET

Retrieves all dmas information.
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-dma-local-cluster-list+xml
application/vnd.plcm.plcm-dma-local-cluster-list+json
Dma list information successfully retrieved.
304
Device information has not changed since the last retrieval.
Note: The API client must provide the "plcm-dma-local-cluster-list" 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 single deivce retrieval in the "If-None-Match" header, then
the HTTP response will contain the device representation in the message
body.

The "plcm-dma-local-cluster-list" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name to ensure an equivalent ETag value. This also assumes no other client made changes to
dmas on the server.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

POST


Add a DMA. description is optional, others are mandatory.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-dma-local-cluster+xml
application/vnd.plcm.plcm-dma-local-cluster+json

Response

Status Representation Description
201 DMA added successfully.
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
The dma already exists.

https://localhost:8443/api/rest/network-device/dmas/{device-uuid}


Template Parameters

Name Type Description
device-uuid xs:string device-uuid arg doc

Methods

DELETE


Deletes information about a DMA
[tags: RPRM]

Response

Status Representation Description
200 DMA successfully deleted