External Poly EVO Peer

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/ext-poly-evo-peer

Summary

Resources	Methods
https://localhost:8443/api/rest/ext-poly-evo-peer	GET Retrieves External Poly EVO Peers. POST Creates a Poly EVO Peer object.
https://localhost:8443/api/rest/ext-poly-evo-peer/{value}	GET Retrieves an External Poly EVO Peer. PUT Updates a Poly EVO peer. DELETE Deletes a Poly EVO Peer.

Resources

https://localhost:8443/api/rest/ext-poly-evo-peer

Methods

GET

Retrieves External Poly EVO Peers. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-ext-poly-evo-peer-list+xml application/vnd.plcm.plcm-ext-poly-evo-peer-list+json	Information successfully retrieved
304		External Poly EVO Peers information has not changed since the last search. Note: The API client must provide the "plcm-ext-poly-evo-peer-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-ext-poly-evopoly-evopoly-evopoly-evopoly-evopoly-evopoly-evopoly-evopoly-evo-peer-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 External Poly EVO Peers on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, provisioner
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Poly EVO Peer not found. There are no Poly EVO Peers stored.

POST

Creates a Poly EVO Peer object. Any submitted ID is ignored.
The ID is assigned by the system.

Name and Poly EVO Peer address are required, and name must be unique.
If a Poly EVO Peer pre-exists with a similar name the request fails.

DMA role required: administrator.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-poly-evo-peer+xml

application/vnd.plcm.plcm-ext-poly-evo-peer+json

application/vnd.plcm.plcm-ext-poly-evo-peer-v4+json

Response

Status	Representation	Description
201		Poly EVO Peer created successfully. The ETag returned in the HTTP header represents the version of the Poly EVO Peer.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	External Poly EVO Peer with that name already exists.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The name of the external peer is required. The name must be between 1 and 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer address is required and must be less than 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer description must be less than 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The virtual address of this server can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	System itself can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The cluster node of this server can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supercluster node can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer port number must be in the range 1024 - 65535.

https://localhost:8443/api/rest/ext-poly-evo-peer/{value}

Template Parameters

Name	Type	Description
value	xs:string	Unique identifier of the External Poly EVO Peer

Methods

GET

Retrieves an External Poly EVO Peer. [tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its immutable, unique identifier: name or ID. The URL form is https://{host}:{port}/api/rest/{resource}/{identifier}

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-ext-poly-evo-peer+xml application/vnd.plcm.plcm-ext-poly-evo-peer+json	Information successfully retrieved
304		External Poly EVO Peer information has not changed since the last search. Note: The API client must provide the "plcm-ext-poly-evo-peer" 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-ext-poly-evo-peer" 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 the External Poly EVO Peer on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such External Poly EVO Peer

PUT

Updates a Poly EVO peer.

DMA role required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-poly-evo-peer+xml

application/vnd.plcm.plcm-ext-poly-evo-peer+json

Response

Status	Representation	Description
204		Poly EVO Peer updated successfully. The ETag returned in the HTTP header represents the current version of the Poly EVO Peer.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no template with the identifier supplied in the URL and/or the body of the request.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL and/or the body of the request cannot be parsed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL does not match that supplied in the body of the request. Only one of these is required but if they are both supplied they must match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag supplied in the header and/or body does not match that on the server. This usually means that the template upon which the update is based has changed since the last time you accessed it.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag is missing and required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag in the header does not match that in the body Only one of these is required but if they are both supplied they must match.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name already used. Since the template to be updated is identified by identifier, not name, the name may be changed, but not to a name that is already taken by another template.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The name of the external peer is required. The name must be between 1 and 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer address is required and must be less than 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer description must be less than 128 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The virtual address of this server can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	System itself can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The cluster node of this server can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supercluster node can't be configured as external peer.luster node of this server can't be configured as external peer.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Poly EVO Peer port number must be in the range 1024 - 65535.

DELETE

Deletes a Poly EVO Peer. [tags: DMA]

Request

Response

Status	Representation	Description
204		Poly EVO Peer deleted successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no Poly EVO Peer with the identifier supplied in the URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL cannot be parsed.