Get Roles
get
/api/AAA/Roles
Gets the roles that match the specified parameters. If no parameters are specified, all preferences are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
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