Name
Reset all permissions any principals have on a SCO to the permissions of its parent SCO. If the parent has no permissions set, the child SCO will also have no permissions.
Availability
Breeze 4
Description
Resets all permissions any principals have on a SCO to the permissions of its parent SCO. If the parent has no permissions set, the child SCO will also have no permissions.
Request URL
http://server_name/api/xml ?action=permissions-reset &acl-id=integer &session=BreezeSessionCookieValue
Parameters
|
Type |
Required |
Description |
acl-id |
BIGINT |
Y |
The ID of a SCO that has permissions you want to reset. |
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=code /> </results>
Response values
Element |
Attribute |
Type |
Description |
results |
|
Container |
All results the action returns. |
status |
|
Empty, with attributes |
The status of the response. |
|
code |
Allowed value |
A code indicating the response status (see status). |
Sample request
https://example.com/api/xml?action=permissions-reset&acl-id=2006334033
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
See also