Site Topology

[tags:DMA]

Resource Root

https://localhost:8443/api/rest/site-topology

Summary

Resources	Methods
https://localhost:8443/api/rest/site-topology
https://localhost:8443/api/rest/site-topology/integrate-with-peer	POST Requests the server to integrate with a peer site topology server.
https://localhost:8443/api/rest/site-topology/unintegrate-from-peer/{site-topology-peer}	POST Request the server to unintegrate with the specified peer.
https://localhost:8443/api/rest/site-topology/integration-status	GET Request the current site topology integration status from the server.
https://localhost:8443/api/rest/site-topology/territory-site-qos-statistics	GET Request site topology Quality Of Service statistics for all sites in the requested territory.
https://localhost:8443/api/rest/site-topology/site-qos-statistics	GET Request site topology Quality Of Service statistics for a specific site.
https://localhost:8443/api/rest/site-topology/site-qos-statistics-list	GET Retrieves information list of site statistics.
https://localhost:8443/api/rest/site-topology/territory-site-link-qos-statistics	GET Request site topology Quality Of Service statistics for all site links in the requested territory.
https://localhost:8443/api/rest/site-topology/site-link-qos-statistics	GET Request site topology Quality Of Service statistics for a specific site link.
https://localhost:8443/api/rest/site-topology/site-link-qos-statistics-list	GET Retrieves information of site link list.
https://localhost:8443/api/rest/site-topology/local-supercluster-node	GET Request the supercluster node information from the server.
https://localhost:8443/api/rest/site-topology/supercluster-node	GET Request the Supercluster node information for the specified node.
https://localhost:8443/api/rest/site-topology/sites	GET Retrieves the list of existing sites. POST Create a single site. POST Creates multiple sites. PUT Updates multiple sites. POST Deletes multiple sites.
https://localhost:8443/api/rest/site-topology/sites/{site-identifier}	GET Retrieves a single site based on the site's unique identifier. PUT Updates a site specified by the specified site identifier. DELETE Deletes the Site specified by the specified site identifier.
https://localhost:8443/api/rest/site-topology/site-links	GET Get all site links. POST Creates a site link definition. POST Creates multiple site links. PUT Updates multiple site links. POST Deletes multiple site links.
https://localhost:8443/api/rest/site-topology/site-links/{site-link-identifier}	GET Retrieves information about a site link. PUT Updates information about a site link. DELETE Deletes a site link.
https://localhost:8443/api/rest/site-topology/site-to-site-exclusions	GET Get all site-to-site exclusions. POST Creates a site-to-site exclusion. POST Creates multiple site to site exclusions. POST Deletes multiple site to site exclusions.
https://localhost:8443/api/rest/site-topology/site-to-site-exclusions/{site-to-site-exclusion-identifier}	GET Retrieves information about a site-to-site exclusion. DELETE Deletes a site-to-site exclusion.
https://localhost:8443/api/rest/site-topology/network-clouds	GET Get all network clouds. POST Creates a network cloud. POST Creates multiple network clouds. PUT Updates multiple network clouds. POST Deletes multiple network clouds.
https://localhost:8443/api/rest/site-topology/network-clouds/{network-cloud-identifier}	GET Retrieves information about a network cloud. PUT Update a network cloud. DELETE Delete a network cloud.
https://localhost:8443/api/rest/site-topology/local-ice-reflexive-addresses	GET Retrieves the list of existing local ICE reflexive addresses. POST Creates a local ICE reflexive address.
https://localhost:8443/api/rest/site-topology/local-ice-reflexive-addresses/{address-uuid}	GET Retrieves a single address based on the address's unique identifier. PUT Updates an address specified by the specified address-uuid. DELETE Deletes the address specified by the specified address-uuid DMA roles required: administrator [tags:DMA_INTERNAL] .

Resources

https://localhost:8443/api/rest/site-topology

https://localhost:8443/api/rest/site-topology/integrate-with-peer

Methods

POST

Requests the server to integrate with a peer site topology server.
If successful, the server's current site topology will be overwritten by the site topology of the peer.
[tags:DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-site-topology-integration-request+xml

application/vnd.plcm.plcm-site-topology-integration-request+json

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-supercluster-node+xml application/vnd.plcm.plcm-site-topology-supercluster-node+json	Successful integration. The supercluster node information of the integrating Call Server is returned.
409		Server is already integrated with another peer site topology server.

https://localhost:8443/api/rest/site-topology/unintegrate-from-peer/{site-topology-peer}

Template Parameters

Name	Type	Description
site-topology-peer	xs:string	Fully qualified domain name or IP address of the site topology peear server to unintegrate from.

Methods

POST

Request the server to unintegrate with the specified peer. As the server can only integrate with a single peer, the site topology server provided in the request
must match the site topology peer currently integrated with.
[tags:DMA_INTERNAL]

Response

Status	Representation	Description
204		Site topology unintegrated successfully
404		The specified server '%0' is not integrated with a peer site topology server.

https://localhost:8443/api/rest/site-topology/integration-status

Methods

GET

Request the current site topology integration status from the server.
[tags:DMA_INTERNAL]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-integration-status+xml application/vnd.plcm.plcm-site-topology-integration-status+json

https://localhost:8443/api/rest/site-topology/territory-site-qos-statistics

Methods

GET

Request site topology Quality Of Service statistics for all sites in the requested territory.
[tags:DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
territory	xs:string	Identifier of the territory to retrieve site QOS statistics for.
include-subnets	xs:boolean	True or False flag indicating if statistics for all subnets belonging to each retrieve site are to be included. This defaults to false if not included.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-qos-statistics-list+xml application/vnd.plcm.plcm-site-topology-qos-statistics-list+json
304		Site QOS statistics information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics-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-site-topology-qos-statistics-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 site topologies on the server.
400		Bad request. Territory not supplied.
404		The specified territory is unknown.

https://localhost:8443/api/rest/site-topology/site-qos-statistics

Methods

GET

Request site topology Quality Of Service statistics for a specific site.
[tags:DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
site	xs:string	Identifier of the site to retrieve the QOS statistics for.
include-subnets	xs:boolean	True or False flag indicating if statistics for all subnets belonging to the site are to be included. This defaults to false if not included.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-site-qos-statistics+xml application/vnd.plcm.plcm-site-topology-site-qos-statistics+json
304		Site QOS statistics information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics" 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-site-topology-qos-statistics" 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 site topologies on the server.
400		Bad request. Site not supplied.
404		The specified site is unknown.

https://localhost:8443/api/rest/site-topology/site-qos-statistics-list

Methods

GET

Retrieves information list of site statistics.
[tags:DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-qos-statistics-list+xml application/vnd.plcm.plcm-site-topology-qos-statistics-list+json
304		Site QOS statistics list information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics-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-site-topology-qos-statistics-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 site topologies on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Current user does not have permission to request information.

https://localhost:8443/api/rest/site-topology/territory-site-link-qos-statistics

Methods

GET

Request site topology Quality Of Service statistics for all site links in the requested territory.
[tags:DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
territory	xs:string	Identifier of the territory to retrieve site link QOS statistics for.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-qos-statistics-list+xml application/vnd.plcm.plcm-site-topology-qos-statistics-list+json
304		Site Link QOS statistics information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics-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-site-topology-qos-statistics-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 the site topology on the server.
400		Bad request. Territory not supplied.
404		The specified territory is unknown.

https://localhost:8443/api/rest/site-topology/site-link-qos-statistics

Methods

GET

Request site topology Quality Of Service statistics for a specific site link.
[tags:DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
site-link	xs:string	Identifier of the site link to retrieve the QOS statistics for.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-qos-statistics+xml application/vnd.plcm.plcm-site-topology-qos-statistics+json
304		Site Link QOS statistics information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics" 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-site-topology-qos-statistics" 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 site topology on the server.
400		Bad request. Site link not supplied.
404		The specified site link siis unknown.

https://localhost:8443/api/rest/site-topology/site-link-qos-statistics-list

Methods

GET

Retrieves information of site link list.
[tags:DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-qos-statistics-list+xml application/vnd.plcm.plcm-site-topology-qos-statistics-list+json
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Current user does not have permission to request information.
304		Site Link QOS statistics list information has not changed since the last search. Note: The API client must provide the "plcm-site-topology-qos-statistics-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-site-topology-qos-statistics-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 the site topology on the server.

https://localhost:8443/api/rest/site-topology/local-supercluster-node

Methods

GET

Request the supercluster node information from the server.
[tags:DMA_INTERNAL]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-supercluster-node+xml application/vnd.plcm.plcm-site-topology-supercluster-node+json	Success

https://localhost:8443/api/rest/site-topology/supercluster-node

Methods

GET

Request the Supercluster node information for the specified node.
[tags:DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
node	xs:string	Identifier of the Supercluster node to retrieve.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-topology-supercluster-node+xml application/vnd.plcm.plcm-site-topology-supercluster-node+json	Success
404		A Supercluster node with the provided node identifier does not exist.

https://localhost:8443/api/rest/site-topology/sites

Methods

GET

Retrieves the list of existing sites.
DMA roles required: administrator, provisioner
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site-list+xml application/vnd.plcm.plcm-site-list+json application/vnd.plcm.plcm-site-list-v2+xml application/vnd.plcm.plcm-site-list-v2+json application/vnd.plcm.plcm-site-list-v3+xml application/vnd.plcm.plcm-site-list-v3+json application/vnd.plcm.plcm-site-list-v4+xml application/vnd.plcm.plcm-site-list-v4+json application/vnd.plcm.plcm-site-list-v5+xml application/vnd.plcm.plcm-site-list-v5+json	Information successfully retrieved
304		Site information has not changed since the last search. Note: The API client must provide the "plcm-site-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-site-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 the conference templates 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

POST

Create a single site.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-site+xml

application/vnd.plcm.plcm-site+json

application/vnd.plcm.plcm-site-v2+xml

application/vnd.plcm.plcm-site-v2+json

application/vnd.plcm.plcm-site-v3+xml

application/vnd.plcm.plcm-site-v3+json

application/vnd.plcm.plcm-site-v4+xml

application/vnd.plcm.plcm-site-v4+json

application/vnd.plcm.plcm-site-v5+xml

application/vnd.plcm.plcm-site-v5+json

Response

Status	Representation	Description
201		Site created successfully
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site name cannot be blank
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site name has already been used
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The specified territory does not exist.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A valid IPv4 call signaling address is required if internet call routing is allowed through a H.323 or SIP aware SBC or ALG.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A valid call signaling port between 1024 and 65535 is required if internet call routing is allowed through a H.323 or SIP aware SBC or ALG.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A valid ISDN dialing method must be configured for automatic or manual ISDN number assignment.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The call line identifier length for direct inward dial ISDN number assignment must be between 0 and 99.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	At least one ISDN range must be configured for direct inward dial ISDN number assignment.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A valid gateway phone number must be configured for gateway extension dialing ISDN number assignment.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A valid E.164 range must be configured for gateway extension dialing ISDN number assignment. The length of the E.164 start must be equal to the length of the E.164 end.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid subnet address. A subnet must contain a valid IPv4 or IPv6 network address with a valid network mask between 0 and 32 for IPv4 and 0 to 128 for Ipv6.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Subnet conflict. The subnet overlaps with another subnet already configured.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No subnet. Each site must contain at least one subnet.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site name is limited to 52 characters when Embedded DNS is enabled.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site topology change is not allowed when DMA is integrated with RPRM.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The system cannot add the site because it reached its physical limit of 500 sites.

POST

Creates multiple sites.
Use this with caution as the amount of time it will take for a response
will be dependent of the number of sites to create.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-site-list-v5+xml

application/vnd.plcm.plcm-site-list-v5+json

Response

Status	Representation	Description
207	application/vnd.plcm.plcm-multistatus+xml application/vnd.plcm.plcm-multistatus+json	The multistatus response containing the creation status of each site. The http-status value is the creation status of the site and will have the same values as the single createSite request.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site topology change is not allowed when DMA is integrated with RPRM.

PUT

Updates multiple sites.
Use with caution as the amount of time it will take for a response
will be dependent of the number of sites being updated.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-site-list-v5+xml

application/vnd.plcm.plcm-site-list-v5+json

Response

Status	Representation	Description
207	application/vnd.plcm.plcm-multistatus+xml application/vnd.plcm.plcm-multistatus+json	The multistatus response will contain a plcm-operation-status entry for each site. The http-status value is the update status of the site and will have the same values as the single updateSite request.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site topology change is not allowed when DMA is integrated with RPRM.

POST

Deletes multiple sites.
Use with caution as the amount of time it will take for a response
will be dependent of the number of sites being deleted.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-bulk-delete+xml

application/vnd.plcm.plcm-bulk-delete+json

Response

Status	Representation	Description
207	application/vnd.plcm.plcm-multistatus+xml application/vnd.plcm.plcm-multistatus+json	The multistatus response containing the deletion status of each site. The http-status value is the deletion status of the site and will have the same values as the single deleteSite request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Site topology change is not allowed when DMA is integrated with RPRM.

https://localhost:8443/api/rest/site-topology/sites/{site-identifier}

Template Parameters

Name	Type	Description
site-identifier	xs:string	identifier of the site.

Methods

GET

Retrieves a single site based on the site's unique identifier.
DMA roles required: administrator
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-site+xml application/vnd.plcm.plcm-site+json application/vnd.plcm.plcm-site-v2+xml application/vnd.plcm.plcm-site-v2+json application/vnd.plcm.plcm-site-v3+xml application/vnd.plcm.plcm-site-v3+json application/vnd.plcm.plcm-site-v4+xml application/vnd.plcm.plcm-site-v4+json application/vnd.plcm.plcm-site-v5+xml application/vnd.plcm.plcm-site-v5+json	Information successfully retrieved
304		Site information has not changed since the last search. Note: The API client must provide the "plcm-site" 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-site" 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 conference templates 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

PUT

Updates a site specified by the specified site identifier.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-site+xml

application/vnd.plcm.plcm-site+json

application/vnd.plcm.plcm-site-v2+xml

application/vnd.plcm.plcm-site-v2+json

application/vnd.plcm.plcm-site-v3+xml