ACLs


[tags: DMA]

Resource Root

https://localhost:8443/api/rest/acl

Summary


Resources Methods
https://localhost:8443/api/rest/acl

https://localhost:8443/api/rest/acl/assignments

GET Retrieves the list policy assignments.

https://localhost:8443/api/rest/acl/assignments/{acl-policy-assignment-identifier}

GET gets the assignment.

https://localhost:8443/api/rest/acl/variables

GET Retrieves the ACL variables.

POST Creates a new ACL variable [tags: DMA] .

https://localhost:8443/api/rest/acl/variables/{acl-variable-identifier}

GET Gets information for an existing variable.

PUT Updates information about an existing variable.

DELETE Deletes the variable if it is unused.

https://localhost:8443/api/rest/acl/policies

GET Retrieves the list of defined policies.

POST Creates a new Policy [tags: DMA] .

https://localhost:8443/api/rest/acl/policies/import

POST  Import an ACL.

https://localhost:8443/api/rest/acl/policies/export

GET  Exports an ACL.

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

GET Retrieves a single policy.

PUT Updates information about an existing ACL policy.

DELETE Deletes the policy if there are no listening point assignments.

https://localhost:8443/api/rest/acl/policies/{acl-policy-identifier}/rules

POST  Adds an ACL rule to a policy at an optionally specified position with a specified action (allow, deny silently, deny respond) and enable/disable flag.

https://localhost:8443/api/rest/acl/policies/{acl-policy-identifier}/rules/{acl-rule-identifier}

GET  Retrieves an ACL rule for a policy [tags: DMA] .

DELETE  Removes an ACL rule from a policy [tags: DMA] .

PUT  Adds an ACL rule to a policy at an optionally specified position with a specified action (allow, deny silently, deny respond) and enable/disable setting.

https://localhost:8443/api/rest/acl/rules

GET Gets the list of defined ACL rules [tags: DMA] .

POST Creates an ACL rule.

https://localhost:8443/api/rest/acl/rules/{acl-rule-identifier}

GET Retrieves information about an ACL rule.

PUT Updates information about an existing ACL rule.

DELETE Deletes the ACL rule.

https://localhost:8443/api/rest/acl/rules/constants

GET Retrieves constant operators and identifiers for building rule expressions [tags: DMA] .

https://localhost:8443/api/rest/acl/variableUpdateAgentSettings

GET Retrieves settings for acl variable update agent [tags: DMA] .

PUT Updates ACL variable update agent settings.

https://localhost:8443/api/rest/acl/variableUpdateAgentSettings/reloadVariables

POST Causes the system to immediately reload the acl variables that are currently configured for automatic updates.

Resources


https://localhost:8443/api/rest/acl


https://localhost:8443/api/rest/acl/assignments


Methods

GET

Retrieves the list policy assignments.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-policy-assignment-list+xml
application/vnd.plcm.plcm-acl-policy-assignment-list+json
Information successfully retrieved
304 Information has not changed since the last retrieval.

Note: The API client should provide the "plcm-acl-policy-assignment-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-acl-policy-assignment-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
dial plans on the server.

https://localhost:8443/api/rest/acl/assignments/{acl-policy-assignment-identifier}


Methods

GET

gets the assignment.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-policy-assignment+xml
application/vnd.plcm.plcm-acl-policy-assignment+json
Assignment successfully retrieved
304 information has not changed since the last retrieval.

Note: The API client should provide the "plcm-acl-policy-assignment" 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-acl-policy-assignment" 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
dial plans 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 assignment.

https://localhost:8443/api/rest/acl/variables


Methods

GET

Retrieves the ACL variables.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-expression-variable-list+xml
application/vnd.plcm.plcm-acl-expression-variable-list+json
information successfully retrieved
304 information has not changed since the last retrieval.

Note: The API client should provide the "plcm-acl-expression-variable-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-acl-expression-variable-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
dial plans on the server.

POST

Creates a new ACL variable
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-expression-variable+xml
application/vnd.plcm.plcm-acl-expression-variable+json

Response

Status Representation Description
201 Variable successfully created.
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
Attempted to create a duplicate variable

https://localhost:8443/api/rest/acl/variables/{acl-variable-identifier}


Methods

GET

Gets information for an existing variable.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-expression-variable+xml
application/vnd.plcm.plcm-acl-expression-variable+json

Response

Status Representation Description
200 Variable information successfully retrieved.
Note: The response will only contain both an ETag value
and link to the updated resource.
304 Information has not changed since the last retrieval.

Note: The API client should provide the "plcm-acl-expression-variable" 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-acl-expression-variable" 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
dial plans 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 variable

PUT

Updates information about an existing variable.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-expression-variable+xml
application/vnd.plcm.plcm-acl-expression-variable+json

Response

Status Representation Description
204 Variable information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated resource.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Cannot edit system variable.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such variable
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The variable resource has changed on the server.

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

The API client must supply the ETag in either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag.
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 either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag.
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 variable if it is unused.
[tags: DMA]

Response

Status Representation Description
204 Variable 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
Only variables that are not referenced in rules may be deleted.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such variable.

https://localhost:8443/api/rest/acl/policies


Methods

GET

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

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-policy-list+xml
application/vnd.plcm.plcm-acl-policy-list+json
Policy list information successfully retrieved
304 Policy list information has not changed since the last retrieval.

Note: The API client should provide the "plcm-acl-policy-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-acl-policy-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
dial plans on the server.

POST

Creates a new Policy
[tags: DMA]

Request

Representations

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

Response

Status Representation Description
201 Policy successfully created.
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
Attempted to create a duplicate policy

https://localhost:8443/api/rest/acl/policies/import


Methods

POST


Import an ACL. [tags: DMA]

Request

Representations

multipart/form-data

Response

Status Representation Description
201 File successfully imported.
402 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file was not free of malware infection and has been 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
File not found for import, imported is invalid.
413 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The uploaded file is too big.
415 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unknown import file format.
429 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest/acl/policies/export


Methods

GET


Exports an ACL.
[tags: DMA]

Request

Response

Status Representation Description
200 application/json
The ACL was successfully downloaded.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation. User roles required: administrator.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed

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


Template Parameters

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

Methods

GET

Retrieves a single policy.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-policy+xml
application/vnd.plcm.plcm-acl-policy+json
Policy information successfully retrieved.
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 policy
304 Information has not changed since the last retrieval.

Note: The API client should provide the "acl-policy" 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 "acl-policy" 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
dial plans on the server.

PUT

Updates information about an existing ACL policy.
[tags: DMA]

Request

Representations

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

Response

Status Representation Description
204 Policy information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated dial plan resource.
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 policy
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The name of a factory default ACL cannot be changed.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The policy resource has changed on the server.

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

The API client must supply the ETag in either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag.
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 either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag.
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 policy if there are no listening point assignments.
[tags: DMA]

Response

Status Representation Description
204 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
Only policies that have no listening points may be deleted.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
This factory default ACL cannot be deleted.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such policy.

https://localhost:8443/api/rest/acl/policies/{acl-policy-identifier}/rules


Template Parameters

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

Methods

POST


Adds an ACL rule to a policy at an optionally specified position with a
specified action (allow, deny silently, deny respond) and enable/disable flag.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-policy-rule+xml
application/vnd.plcm.plcm-acl-policy-rule+json

Response

Status Representation Description
204 Rule successfully added to policy
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 policy or no such rule to add

https://localhost:8443/api/rest/acl/policies/{acl-policy-identifier}/rules/{acl-rule-identifier}


Template Parameters

Name Type Description
acl-policy-identifier xs:string The unique identifier of the policy
acl-rule-identifier xs:string The unique identifier of the ACL rule

Methods

GET


Retrieves an ACL rule for a policy
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-policy-rule+xml
application/vnd.plcm.plcm-acl-policy-rule+json
Rule was successfully retrieved.
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 rule to delete.

DELETE


Removes an ACL rule from a policy
[tags: DMA]

Response

Status Representation Description
204 rule successfully removed from policy
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 rule to delete.

PUT


Adds an ACL rule to a policy at an optionally specified position with a
specified action (allow, deny silently, deny respond) and enable/disable setting.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-policy-rule+xml
application/vnd.plcm.plcm-acl-policy-rule+json

Response

Status Representation Description
204 Policy rule successfully updated.
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 policy rule to update.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ACL rule resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's dial rule 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-acl-rule.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-acl-rule.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.

https://localhost:8443/api/rest/acl/rules


Methods

GET

Gets the list of defined ACL rules
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-rule-list+xml
application/vnd.plcm.plcm-acl-rule-list+json
List returned
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

POST

Creates an ACL rule.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-rule+xml
application/vnd.plcm.plcm-acl-rule+json

Response

Status Representation Description
201 Rule 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/acl/rules/{acl-rule-identifier}


Template Parameters

Name Type Description
acl-rule-identifier xs:string The unique identifier of the ACL rule

Methods

GET

Retrieves information about an ACL rule.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-rule+xml
application/vnd.plcm.plcm-acl-rule+json
ACL rule successfully retrieved.
304 ACL rule information has not changed since the last retrieval.
Note: The API client should provide the "plcm-acl-rule" 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 dial rule retrieval in the "If-None-Match" header, then
the HTTP response will contain the dial rule representation in the message
body.

The "plcm-acl-rule" 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
dial rule 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 ACL rule

PUT

Updates information about an existing ACL rule.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-rule+xml
application/vnd.plcm.plcm-acl-rule+json

Response

Status Representation Description
204 Rule information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated dial rule resource.
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 ACL rule
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Default rule can not be modified
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ACL rule resource has changed on the server.

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

The API client must supply the ETag in either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-acl-rule.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 either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-acl-rule.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 ACL rule.
[tags: DMA]

Response

Status Representation Description
204 ACL rule 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
Only ACL rules that are not in use can be deleted.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such ACL rule.

https://localhost:8443/api/rest/acl/rules/constants


Methods

GET

Retrieves constant operators and identifiers for building rule expressions
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-rule-constants-list+xml
application/vnd.plcm.plcm-acl-rule-constants-list+json
ACL rule successfully retrieved.
304 ACL rule information has not changed since the last retrieval.
Note: The API client should provide the "plcm-acl-rule-constants-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 single dial rule retrieval in the "If-None-Match" header, then
the HTTP response will contain the dial rule representation in the message
body.

The "plcm-acl-rule-constants-list" 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
dial rule on the server.
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/acl/variableUpdateAgentSettings


Methods

GET

Retrieves settings for acl variable update agent
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-acl-variable-update-agent-settings+xml
application/vnd.plcm.pplcm-acl-variable-update-agent-settings+json
Variable update agent settings successfully retrieved.
304 ACL variable update agent settings have not changed since the last retrieval.
Note: The API client should provide the "plcm-acl-variable-agent-settings" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

PUT

Updates ACL variable update agent settings.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-acl-variable-update-agent-settings+xml
application/vnd.plcm.plcm-acl-variable-update-agent-settings+json

Response

Status Representation Description
204 Agent settingswere successfully updated.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ACL variable update agent settings resource has changed on the server.

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

The API client must supply the ETag in either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-acl-variable-agent-settings.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 either the "If-Match" header or the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-acl-rule.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.

https://localhost:8443/api/rest/acl/variableUpdateAgentSettings/reloadVariables


Methods

POST

Causes the system to immediately reload the acl variables that are currently configured for automatic updates.
[tags: DMA]

Response

Status Representation Description
202 The request has been accepted to reload acl variables.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.