registration-policies



On the Registration Policies 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.
[tags: DMA]

Resource Root

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

Summary


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

GET  Retrieves the list of registration policies.

POST  Creates a registration policy.

https://localhost:8443/api/rest/registration-policies/{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-policies/{registration-policy-identifier}/debug-postliminary

POST  A debug mechanism for a registration policy script.

https://localhost:8443/api/rest/registration-policies/apply

POST  Applies all currently defined policies to existing registered endpoints.

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

GET  Get default values for a DMA registration policy.

Resources


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


Methods

GET


Retrieves the list of registration policies.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-registration-policy-list-v2+xml
application/vnd.plcm.plcm-registration-policy-list-v2+json

Registration policy information successfully retrieved.
304
Registration policy information has not changed since the last retrieval.

Note: The API client must provide the "plcm-registration-policy-list-v2" 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-registration-policy-list-v2" 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
registration policies on the server.

POST


Creates a registration policy.
[tags: DMA]

Request

Response

Status Representation Description
201
Registration policy successfully created.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/registration-policies/{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.
[tags: DMA]

Response

Status Representation Description
200
Registration policy information successfully retrieved.


304
Registration policy information has not changed since the last retrieval.

Note: The API client must provide the "plcm-registration-policy-list-v2" 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-registration-policy-list-v2" 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
registration policies on the server.

PUT


Updates an existing registration policy.
[tags: DMA]

Request

Response

Status Representation Description
204
Registration policy information successfully updated.
Note: the response will only contain both an ETag value
and link to the updated registration policy resource.
304
Registration policy information has not changed since the last retrieval.
Note: The API client must provide the "plcm-registration-policy-v2" 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 single registration policy retrieval in the "If-None-Match" header, then
the HTTP response will contain the registration policy representation in the message
body.

The "plcm-registration-policy" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name to ensure an equivalent ETag value. This also assumes no other client made changes to
registration policy on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unable to get permission. Administrator user role required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

No such registration policy.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The name of the default registration policy cannot be changed.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The registration policy resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's registration policy resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-registration-policy-v2.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-registration-policy-v2.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.

DELETE


Deletes the registration policy.
[tags: DMA]

Response

Status Representation Description
204
Registration policy successfully deleted.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unable to get permission. Administrator user role required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

This default registration policy cannot be deleted.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

No such registration policy.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Only registration policies that have no signaling ports may be deleted.

https://localhost:8443/api/rest/registration-policies/{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 registration policy script. You can specify various parameters
and debug the input script.
[tags: DMA]

Request

Representations

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

Response

Status Representation Description
200 application/vnd.plcm.plcm-registration-policy-debug-result+xml
application/vnd.plcm.plcm-registration-policy-debug-result+json

The registration policy debug has completed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/registration-policies/apply


Methods

POST


Applies all currently defined policies to existing registered endpoints.
[tags: DMA]

Response

Status Representation Description
200
Policies successfully applied.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Authentication failed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

User has insufficient permissions to perform the operation.

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


Methods

GET


Get default values for a DMA registration policy.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-registration-policy-defaults+xml
application/vnd.plcm.plcm-registration-policy-defaults+json

Successfully retrieved default values.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Unable to get permission.