All business operations entities are structured as follows:
entity
:
[string] UID
: The unique identifier of the business operation[string] SingularName
: The name of the operation in singular form. This value is useful for displaying in entity properties dialogs.[string] PluralName
: The name of the operation in plural form. This value is useful for displaying in user and role properties dialogs.[string] FullName
: The name of the current operation along with its parent operations (if any). Since many operation names aren't unique, this value is useful for differentiating similar business operations.[EntityType] TargetEntity
: The target entity for a given operation (“devices” in this instance)[BusinessOperation] Parent
: An operation instance indicating the operation from which permissions are inherited. This value will be "null" if there is no parent operation.[BusinessOperation[]] Descendants
: An array of operation instances that inherit permissions from this operation. This value is "null" if there are no descendant operations.[Permission[]] Permissions
: An array of permission instances indicating permissions associated with this operation. Supported representations include:
The identifier of the target entity instance. This will always be “null” because it only includes the device entity.
EntityId:[
int?
]
The unique identifier for the operation
OperationUID:[
string
][Principal] Principal:
Defines to whom the permission is granted (to Administrator, a user, etc.)[string] name:
The name associated with the permissions (for example, "Custom Administrators")[bool]
isCustom:
If true, this is a custom roletype:
Either "User" or "Role"[int]
id:
The id of the user or role
Indicates if the device permissions are editable by customer or not
IsFixed:[
bool
]
If true, the device permissions are inherited
IsInherited:[
bool
]
Allows or denies permissions to perform a given operation
IsAllowed:[
bool
][DateTime] CreationDate:
The date that the device permissions were created