Remote Alert Profile

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/remote-alert-profiles

Summary

Resources	Methods
https://localhost:8443/api/rest/remote-alert-profiles	GET Get the list of remote alert profile information objects [tags: RPRM] .
https://localhost:8443/api/rest/remote-alert-profiles/{remote-alert-profile-identifier}	GET Retrieves remote alert profile with passed id.

Resources

https://localhost:8443/api/rest/remote-alert-profiles

Methods

GET

Get the list of remote alert profile information objects
[tags: RPRM]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-remote-alert-profile-list+xml application/vnd.plcm.plcm-remote-alert-profile-list+json	Remote alert profile list information successfully retrieved
304		Remote Alert Profile information has not changed since the last search. Note: The API client must provide the "plcm-remote-alert-profile-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-remote-alert-profile-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 remote-alert-profiles on the server.

https://localhost:8443/api/rest/remote-alert-profiles/{remote-alert-profile-identifier}

Template Parameters

Name	Type	Description
remote-alert-profile-identifier	xs:string

Methods

GET

Retrieves remote alert profile with passed id.
[tags: RPRM]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-remote-alert-profile+xml application/vnd.plcm.plcm-remote-alert-profile+json	Remote alert profile successfully retrieved
304		Remote alert profile information has not changed since the last search. Note: The API client must provide the "plcm-remote-alert-profile" 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-remote-alert-profile" 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 remote-alert-profiles on the server.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such remote alert profile.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Remote alert profile identifier is invalid.