Configuration

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/config

Summary

Resources	Methods
https://localhost:8443/api/rest/config
https://localhost:8443/api/rest/config/call-server
https://localhost:8443/api/rest/config/call-server/call-server-config	GET Retrieves Call Server configuration settings. PUT Update the call server configuration settings.
https://localhost:8443/api/rest/config/call-server/call-server-config/default	GET Retrieves Call Server default configuration settings.
https://localhost:8443/api/rest/config/call-server/history-retention-config	GET Retrieves History Retention settings. PUT Update current History Retention configuration.
https://localhost:8443/api/rest/config/call-server/history-retention-config/default	GET Retrieves History Retention settings.
https://localhost:8443/api/rest/config/cluster
https://localhost:8443/api/rest/config/cluster/logging	GET Retrieves Logging configuration. PUT Update current Logging configuration.
https://localhost:8443/api/rest/config/cluster/physical-limits	GET Retrieves Physical Limits configuration. PUT Update current Physical Limits configuration.
https://localhost:8443/api/rest/config/root-password	POST Changes password of the root user.
https://localhost:8443/api/rest/config/remote-password	POST Changes password of the remote user.
https://localhost:8443/api/rest/config/initial-configuration	POST Sets the initial configuration of Polycom RealPresence DMA. GET Retrieves the choice of initial configuration. PUT updates the value of hide * menus for Polycom RealPresence DMA DMA roles required: any authenticated user [tags: DMA_INTERNAL] .

Resources

https://localhost:8443/api/rest/config

https://localhost:8443/api/rest/config/call-server

https://localhost:8443/api/rest/config/call-server/call-server-config

Methods

GET

Retrieves Call Server configuration settings.
DMA role required: administrator, provisioner

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-call-server+xml application/vnd.plcm.plcm-call-server+json application/vnd.plcm.plcm-call-server-v2+xml application/vnd.plcm.plcm-call-server-v2+json application/vnd.plcm.plcm-call-server-v3+xml application/vnd.plcm.plcm-call-server-v3+json application/vnd.plcm.plcm-call-server-v4+xml application/vnd.plcm.plcm-call-server-v4+json	Information successfully retrieved
304		Call Server information has not changed since the last search. Note: The API client must provide the "plcm-call-server" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance 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-call-server" 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 conference templates on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required:administrator, provisioner

PUT

Update the call server configuration settings.
DMA role required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-call-server+xml

application/vnd.plcm.plcm-call-server+json

application/vnd.plcm.plcm-call-server-v2+xml

application/vnd.plcm.plcm-call-server-v2+json

application/vnd.plcm.plcm-call-server-v3+xml

application/vnd.plcm.plcm-call-server-v3+json

application/vnd.plcm.plcm-call-server-v4+xml

application/vnd.plcm.plcm-call-server-v4+json

Response

Status	Representation	Description
204		Call Server configuration updated successfully. The ETag returned in the HTTP header represents the version of the current configuration.
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	User has insufficient permissions to perform the operation. DMA role required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Available bandwidth limit must be a number between 0-100.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Timeout for call forwarding when no answer must be a number between 5-32.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	IRQ interval must be a number between 10-600.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Location request hop count must be a number between 1-256.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Location request time out must be a number between 0-9999.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Minimum SIP registration interval must be between 150 and 3600 seconds and less than or equal to the registration refresh interval.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The peer timeout must be a number between 3-300.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The registration refresh interval must be a number between 150-9999.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The territory refresh interval must be a number between 6-300.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The lync query timeout must be a number between 1 and 20.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Bandwidth Conversion Factor must be a number between 1 and 5 inclusive with at most a precision after the decimal of 3. EG: "1.000" to "5.000".
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	SIP CLRF keep-alive interval for non RFC-5626 endpoints must be a number between 60-9999.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A port range conflicts with other ports for services configured on the system.

https://localhost:8443/api/rest/config/call-server/call-server-config/default

Methods

GET

Retrieves Call Server default configuration settings.
DMA role required: administrator, provisioner

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-call-server+xml application/vnd.plcm.plcm-call-server+json application/vnd.plcm.plcm-call-server-v2+xml application/vnd.plcm.plcm-call-server-v2+json application/vnd.plcm.plcm-call-server-v3+xml application/vnd.plcm.plcm-call-server-v3+json application/vnd.plcm.plcm-call-server-v4+xml application/vnd.plcm.plcm-call-server-v4+json	Information successfully retrieved
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required:administrator, provisioner

https://localhost:8443/api/rest/config/call-server/history-retention-config

Methods

GET

Retrieves History Retention settings.
DMA roles required: administrator, auditor

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-history-retention+xml application/vnd.plcm.plcm-history-retention+json	Information successfully retrieved
304		History Retention information has not changed since the last search. Note: The API client must provide the "plcm-history-retention" 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-history-retention" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required: administrator, auditor

PUT

Update current History Retention configuration.

DMA roles required: administrator, auditor

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-history-retention+xml

application/vnd.plcm.plcm-history-retention+json

Response

Status	Representation	Description
204		History Retention config updated successfully. The ETag returned in the HTTP header represents the version of the current configuration.
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	User has insufficient permissions to perform the operation. DMA role required: administrator, auditor
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The low value signaling threshold must be a number between 0-10.

https://localhost:8443/api/rest/config/call-server/history-retention-config/default

Methods

GET

Retrieves History Retention settings.
DMA roles required: administrator, auditor

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-history-retention+xml application/vnd.plcm.plcm-history-retention+json	Information successfully retrieved
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required: administrator, auditor

https://localhost:8443/api/rest/config/cluster

https://localhost:8443/api/rest/config/cluster/logging

Methods

GET

Retrieves Logging configuration.
DMA roles required: administrator, auditor

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-logging+xml application/vnd.plcm.plcm-logging+json application/vnd.plcm.plcm-logging-v2+xml application/vnd.plcm.plcm-logging-v2+json	Information successfully retrieved
304		Logging information has not changed since the last search. Note: The API client must provide the "plcm-logging" 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-logging" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required: administrator

PUT

Update current Logging configuration.
DMA roles required: administrator, auditor

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-logging+xml

application/vnd.plcm.plcm-logging+json

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

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

Response

Status	Representation	Description
201		Logging config updated successfully. The ETag returned in the HTTP header represents the version of the current configuration.
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	User has insufficient permissions to perform the operation. DMA roles required: administrator

https://localhost:8443/api/rest/config/cluster/physical-limits

Methods

GET

Retrieves Physical Limits configuration.
DMA roles required: administrator, auditor

[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-physical-limits+xml application/vnd.plcm.plcm-physical-limits+json application/vnd.plcm.plcm-physical-limits-v2+xml application/vnd.plcm.plcm-physical-limits-v2+json	Information successfully retrieved
304		Physical Limits information has not changed since the last search. Note: The API client must provide the "plcm-physical-limits" 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-physical-limits" 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.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required: administrator

PUT

Update current Physical Limits configuration.
DMA roles required: administrator, auditor

[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-physical-limits+xml

application/vnd.plcm.plcm-physical-limits+json

application/vnd.plcm.plcm-physical-limits-v2+xml

application/vnd.plcm.plcm-physical-limits-v2+json

Response

Status	Representation	Description
201		Physical Limits configuration updated successfully. The ETag returned in the HTTP header represents the version of the current configuration.
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	User has insufficient permissions to perform the operation. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid maximum value assigned within physical limits configuration.

https://localhost:8443/api/rest/config/root-password

Methods

POST

Changes password of the root user. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-change-password-request+xml

application/vnd.plcm.plcm-change-password-request+json

Response

Status	Representation	Description
204		User password was successfully updated.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Old password is not valid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	New password was used before.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	This feature may only be accessed once per minute.

https://localhost:8443/api/rest/config/remote-password

Methods

POST

Changes password of the remote user. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-change-password-request+xml

application/vnd.plcm.plcm-change-password-request+json

Response

Status	Representation	Description
204		User password was successfully updated.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Old password is not valid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	New password was used before.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	This feature may only be accessed once per minute.

https://localhost:8443/api/rest/config/initial-configuration

Methods

POST

Sets the initial configuration of Polycom RealPresence DMA.
The initial configuration may be stored once
()and only once) via this API call. It will default to the choice
"NONE" at system installation but will
afterwards reflect the administrator's choice for subsequent GET calls.

[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-initial-configuration+xml

application/vnd.plcm.plcm-initial-configuration+json

Response

Status	Representation	Description
204		Initial configuration was successfully saved.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request. The initial configuration choice was not valid.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User has insufficient permissions to perform the operation. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The initial configuration has already been specified and may not be changed.

GET

Retrieves the choice of initial configuration. The initial configuration
will always be accessible
via this API call. It will default to the choice "NONE" at system
installation. The choice can be
updated only once when the administrator logs into the DMA for the first
time. After the choice
has been updated this API will return the value specified in the
POST.

DMA roles required: any authenticated user

[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-initial-configuration+xml application/vnd.plcm.plcm-initial-configuration+json	Information successfully retrieved

PUT

updates the value of hide * menus for Polycom RealPresence DMA
DMA roles required: any authenticated user

[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
204		Information update successfully
412		The client supplied ETag does not match ETag value on the server. This will normally mean that the client does not have the latest version of the initial configuration information.
428		Device ETag has not been supplied in the "If-Match" header.
403		User has insufficient permissions to perform the operation
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The initial configuration has already been specified and may not be changed.