Create a Role
post
/api/AAA/Roles
Creates a new role.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
The role description.Example:
Administrators have complete access to all user interfaces
-
Permissions: array
Permissions
The permissions associated with the role.
-
RoleName: string
The role name.Example:
Administrator
Nested Schema : items
Type:
Show Source
object
-
CreateAvailable: integer
Create Available (Uses a tinyint type)Example:
0
-
CreateFlag: integer
Create Flag (a tinyint-like flag)Example:
0
-
DeleteAvailable: integer
Delete Available (Uses a tinyint type)Example:
0
-
DeleteFlag: integer
Delete Flag (a tinyint-like flag)Example:
0
-
Description: string
The permission description.Example:
Assigns administrative rights to view and modify items even if not the owner
-
ExecuteAvailable: integer
Execute Available (Uses a tinyint type)Example:
0
-
ExecuteFlag: integer
Execute Flag (a tinyint-like flag)Example:
0
-
PackageName: string
The package name.Example:
global
-
PermissionID: integer
The permission ID.Example:
10001
-
PermissionName: string
The permission name.Example:
SUPER
-
ReadAvailable: integer
Read Available (Uses a tinyint type)Example:
0
-
ReadFlag: integer
Read Flag (a tinyint-like flag)Example:
0
-
UpdateAvailable: integer
Update Available (Uses a tinyint type)Example:
0
-
UpdateFlag: integer
Update Flag (a tinyint-like flag)Example:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : AAARolesRead
Type:
Show Source
object
-
Description: string
The role description.Example:
Administrators have complete access to all user interfaces
-
Permissions: array
Permissions
The permissions associated with the role.
-
RoleID: integer
The role ID.Example:
1
-
RoleName: string
The role name.Example:
Administrator
Nested Schema : items
Type:
Show Source
object
-
CreateAvailable: integer
Create Available (Uses a tinyint type)Example:
0
-
CreateFlag: integer
Create Flag (a tinyint-like flag)Example:
0
-
DeleteAvailable: integer
Delete Available (Uses a tinyint type)Example:
0
-
DeleteFlag: integer
Delete Flag (a tinyint-like flag)Example:
0
-
Description: string
DescriptionExample:
Assigns administrative rights to view and modify items even if not the owner
-
ExecuteAvailable: integer
Execute Available (Uses a tinyint type)Example:
0
-
ExecuteFlag: integer
Execute Flag (a tinyint-like flag)Example:
0
-
PackageName: string
The package name.Example:
global
-
PermissionID: integer
The permission ID.Example:
10001
-
PermissionName: string
The permission name.Example:
SUPER
-
ReadAvailable: integer
Read Available (Uses a tinyint type)Example:
0
-
ReadFlag: integer
Read Flag (a tinyint-like flag)Example:
0
-
UpdateAvailable: integer
Update Available (Uses a tinyint type)Example:
0
-
UpdateFlag: integer
Update Flag (a tinyint-like flag)Example:
0
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object