Description
This class controls Access Right objects.
Properties
Property name | Description | Data type | Read-only |
---|---|---|---|
entityId | The database ID of the object to which the access right applies. This value must be greater than 0. | integer (int64) | No |
userId | The database ID of the owner of the access right. This value must be greater than 0. | integer (int64) | No |
value | The default access right (HIDE, VIEW, ADD, CHANGE, or FULL). This field cannot be null. | string | No |
overrides | Indicates the types that are to be overridden in the access right in the format objectType=accessRightValue where objectType is the same object type used in APIEntity and accessRightValue is one of HIDE, VIEW, ADD, CHANGE or FULL. Multiple override elements are separated by a | (pipe) character. | string | No |
properties | A string containing extra properties for the object in the format attribute=value. | string | No |
Example
{
"entityId": 12345,
"userId": 12345,
"value": "...",
"overrides": "...",
"properties": "..."
}