Update a User Group Property
put
/api/AAA/UserGroupProperties/{id}
Updates the properties of the user group property that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The property ID.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Details of the user group property to create or update.
Show Source
-
PropertyDescription: 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
-
PropertyName: string
The property name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:RestrictiveDeviceGroupID
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulUpdateOperation
The response body for a successful update operation.
-
object
type
Nested Schema : SuccessfulUpdateOperation
Type:
object
The response body for a successful update operation.
Show Source
-
message: string
The response message.Example:
Updated 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 : 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.