registration-policy



On the Registration Policy API, you can specify policies to control registration by endpoints.
Select the action to be taken when an endpoint is compliant, and the action to be
taken when an endpoint is noncompliant.

Note: The API resource /api/rest/registration-policy has been deprecated by the RealPresence DMA system.
If you wish to use functionality formerly provided by this API resource, you will need to modify your
applications to make use of the replacement API resource /api/rest/registration-policies.
[tags: DMA]

Resource Root

https://localhost:8443/api/rest/registration-policy

Summary


Resources Methods
https://localhost:8443/api/rest/registration-policy

GET  Retrieves the registration policy.

GET  Retrieves the list of registration policies.

PUT  Updates the registration policy record.

POST  Creates a registration policy.

https://localhost:8443/api/rest/registration-policy/reapply-policy

POST  It will run the script, applying any changes admin made to existing registered endpoints.

https://localhost:8443/api/rest/registration-policy/debug-postliminary

POST  A debug mechanism for the current registration policy script.

https://localhost:8443/api/rest/registration-policy/{registration-policy-identifier}/debug-postliminary

POST  A debug mechanism for a single registration policy script.

https://localhost:8443/api/rest/registration-policy/{registration-policy-identifier}

GET  Retrieves a single registration policy.

PUT  Updates an existing registration policy.

DELETE  Deletes the registration policy.

https://localhost:8443/api/rest/registration-policy/defaults

GET  Get default values for the DMA registration policy.

Resources


https://localhost:8443/api/rest/registration-policy


Methods

GET


Retrieves the registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

GET


Retrieves the list of registration policies.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

PUT


Updates the registration policy record.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-policy+xml
application/vnd.plcm.plcm-registration-policy+json

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

POST


Creates a registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-policy-v2+xml
application/vnd.plcm.plcm-registration-policy-v2+json

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

https://localhost:8443/api/rest/registration-policy/reapply-policy


Methods

POST


It will run the script, applying any changes admin made to existing registered endpoints.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

https://localhost:8443/api/rest/registration-policy/debug-postliminary


Methods

POST


A debug mechanism for the current registration policy script. You can specify various parameters
and debug the input script.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-policy-debug-request+xml
application/vnd.plcm.plcm-registration-policy-debug-request+json
application/vnd.plcm.plcm-registration-policy-debug-request-v2+xml
application/vnd.plcm.plcm-registration-policy-debug-request-v2+json

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

https://localhost:8443/api/rest/registration-policy/{registration-policy-identifier}/debug-postliminary


Template Parameters

Name Type Description
registration-policy-identifier xs:string The unique identifier of the registration policy

Methods

POST


A debug mechanism for a single registration policy script. You can specify various parameters
and debug the input script.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-policy-debug-request+xml
application/vnd.plcm.plcm-registration-policy-debug-request+json
application/vnd.plcm.plcm-registration-policy-debug-request-v2+xml
application/vnd.plcm.plcm-registration-policy-debug-request-v2+json

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

https://localhost:8443/api/rest/registration-policy/{registration-policy-identifier}


Template Parameters

Name Type Description
registration-policy-identifier xs:string The unique identifier of the registration policy

Methods

GET


Retrieves a single registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

PUT


Updates an existing registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-registration-policy-v2+xml
application/vnd.plcm.plcm-registration-policy-v2+json

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

DELETE


Deletes the registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.

https://localhost:8443/api/rest/registration-policy/defaults


Methods

GET


Get default values for the DMA registration policy.

Note: This method has been deprecated by the RealPresence DMA system.
You should modify your applications to make use of the replacement API resource
/api/rest/registration-policies.
[tags: DMA]

Response

Status Representation Description
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
410 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested resource is gone.