Get a User Group Property by ID
get
/api/AAA/UserGroupProperties/{id}
Gets the user group property that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The property ID.Example:
3
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
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 : data
Type:
Show Source
array
-
Array of:
object AAAUserGroupPropertiesRead
User group property details.
Nested Schema : AAAUserGroupPropertiesRead
Type:
object
User group property details.
Show Source
-
Description: string
The description of the property.Example:
Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups
-
PropertyID: integer
The property ID.Example:
1
-
PropertyName: string
The property name.Example:
RestrictiveDeviceGroupID
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.