Profile



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/uc-profile-deployments

Summary


Resources Methods
https://localhost:8443/api/rest/uc-profile-deployments

https://localhost:8443/api/rest/uc-profile-deployments/{condition-type}/{condition-identifier}

GET  Retrieves information about the resource profiles deployment.

PUT  Updates information about the resource profiles deployment.

Resources


https://localhost:8443/api/rest/uc-profile-deployments


https://localhost:8443/api/rest/uc-profile-deployments/{condition-type}/{condition-identifier}


Template Parameters

Name Type Description
condition-type xs:string Condition type. Support devices,device-groups,models,sites,global.
condition-identifier xs:string Condition identifier. Identifier of the condition type resource. If condition-type is global, condition-identifier must be 1.

Methods

GET


Retrieves information about the resource profiles deployment.
[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-uc-profile-deployment+xml
application/vnd.plcm.plcm-uc-profile-deployment+json
Profiles deployment information successfully retrieved.
Applied to RPRM,plcm-uc-profile-deployment is implemented and according mediaType can be accessed by setting Http Accept.
304
The resource profiles deployment information has not changed since the last retrieval.
Note: The API client must provide the "plcm-uc-profile-deployment" 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-uc-profile-deployment" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
profiles deployment on the server.
400 text/plain
Condition-type is required.
400 text/plain
Condition-identifier is required.
400 text/plain
Condition-type is not valid. Support devices,device-groups,models,sites,global.
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
Profiles deployment does not exist.

PUT


Updates information about the resource profiles deployment.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-uc-profile-deployment+xml
application/vnd.plcm.plcm-uc-profile-deployment+json

Response

Status Representation Description
204
The resource profiles deployment information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated profile resource.
400 text/plain
Condition-type is required.
400 text/plain
Condition-identifier is required.
400 text/plain
Condition-type is not valid. Support devices,device-groups,models,sites,global.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Profile-identifier is not valid. The profile with the supplied profile identifier does not exist on the Call Server.
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
Deployment resource does not exist.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The deployment resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's profile 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-uc-profile-deployment.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-uc-profile-deployment.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.