DeviceGroup



[tags: RPRM]

Resource Root

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

Summary


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

GET  Retrieves all device groups information.

POST  Add a device group.

https://localhost:8443/api/rest/device-groups/{device-group-identifier}

GET  Retrieves information about a DeviceGroup.

DELETE  Deletes information about a device group.

PUT  Updates information about a device group.

https://localhost:8443/api/rest/device-groups/{device-group-identifier}/associated-devices

GET  Retrieves association device list.

PUT  Update associated device list.

Resources


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


Methods

GET


Retrieves all device groups information.

Note 1: The default, maximum number of device groups returned from the server is 1000.
Clients should use the "limit" query parameter to further control the results to the
number they can support.

[tags: RPRM]

Request

Query Parameters

Name Type Description
device-group-name xs:string Return device groups that match the group name.
limit xs:int
Limit the number of device groups returned to this number, even if more device groups match the query.
Note 1: The valid integer range is 1 to 2147483647.
Note 2: If the limit value is less than or equal to zero, the system will ignore the limit request and return all results.
Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found".
This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status Representation Description
200 application/vnd.plcm.plcm-device-group-list+xml
application/vnd.plcm.plcm-device-group-list+json
Device group list information successfully retrieved.
Applied to RPRM, plcm-device-group-list is implemented and according mediaType can be accessed by setting Http Accept.
304
Device group information has not changed since the last search.

Note: The API client must provide the "plcm-device-group-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
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-device-group-list" 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
device groups on the server.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

POST


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

Request

Representations

application/vnd.plcm.plcm-device-group+xml
application/vnd.plcm.plcm-device-group+json

Response

Status Representation Description
201 Device group added successfully.
400 text/plain
Device-group-identifier can not be initialized when creating a device group.
400 text/plain
Device-group-name is required.
400 text/plain
Device-group-name already exists.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.

https://localhost:8443/api/rest/device-groups/{device-group-identifier}


Template Parameters

Name Type Description
device-group-identifier xs:string device-group-identifier

Methods

GET


Retrieves information about a DeviceGroup.
[tags: RPRM]

Response

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

The "plcm-device-group" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
device groups on the server.
400 text/plain
Device-group-identifier is not valid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device group does not exist.

DELETE


Deletes information about a device group.
[tags: RPRM]

Response

Status Representation Description
204 Device group successfully deleted
400 text/plain
Device-group-identifier is not valid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device group does not exist.

PUT


Updates information about a device group.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-device-group+xml
application/vnd.plcm.plcm-device-group+json

Response

Status Representation Description
204
Device group information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated device group resource.
400 text/plain
Device-group-identifier is not valid.
400 text/plain
Device-group-name is required.
400 text/plain
Device-group-name already exists.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device group does not exist.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The device group resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's device group resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-device-group.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-device-group.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.

https://localhost:8443/api/rest/device-groups/{device-group-identifier}/associated-devices


Template Parameters

Name Type Description
device-group-identifier xs:string device-group-identifier

Methods

GET


Retrieves association device list.
[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-device-summary-list+xml
application/vnd.plcm.plcm-device-summary-list+json
Device associated list successfully retrieved.
304
Associated device list has not changed since the last retrieval.
Note: The API client must provide the "plcm-device-summary-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-device-summary-lis" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
associated device list on the server.

400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device-group-identifier is not valid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device group not found. The device group with the supplied device-group identifier does not exist on the Call Server.

PUT


Update associated device list.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-device-summary-list+xml
application/vnd.plcm.plcm-device-summary-list+json

Response

Status Representation Description
204 Associated device list updated successfully
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device-group-identifier is not valid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device group not found. The device group with the supplied device-group identifier does not exist on the Call Server.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device not found. The device with the supplied device identifier does not exist on the Call Server..
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Device ID is invalid.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The device group associated device list has changed on the server.

Note: The response will contain the ETag value that reflects
the server's associated device list resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-device-summary-list.xsd" for details.

428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-device-summary-list.xsd" for details.