GET
Retrieves a list of softwares matching the input search filter parameters.
Note 1: The default, maximum number of softwares 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-type |
xs:string |
Return only softwares that match the device-type. Support Polycom Phone, Group Series, Polycom Studio, EagleEye Cube and G
Series.
|
| software-name |
xs:string |
Return only softwares that match the software-name. |
| software-version |
xs:string |
Return only softwares that match the software-version. |
| limit |
xs:int |
Limit the number of softwares returned to this number, even if more softwares 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-uc-profile-software-list+xml
application/vnd.plcm.plcm-uc-profile-software-list+json
|
Software information successfully retrieved.
Applied to RPRM, plcm-uc-profile-software-list is implemented and according mediaType can be accessed by setting Http Accept.
|
| 304 |
|
Software information has not changed since the last search.
Note: The API client must provide the "plcm-uc-profile-software-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-uc-profile-software-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
softwares on the server.
|
| 403 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
Unable to get permission. |
|