PUT List/UserGroup/Items/{id}
Some tooltip text!
• 3 minutes to read
• 3 minutes to read
PUT /api/v1/List/UserGroup/Items/{id}
Updates the existing UserGroup
Calls the User agent service SaveUserGroup.
| Path Part | Type | Description |
|---|---|---|
| id | int32 | The id of UserGroup to be saved. Required |
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: entity
The details of UserGroup to be saved.
| Property Name | Type | Description |
|---|---|---|
| Value | String | UserGroup name |
| Tooltip | String | Tooltip or other description |
| Id | Integer | Primary key |
| Rank | Integer | Rank order |
| Deleted | Boolean | Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
| 400 | Bad request. Entity to save is not in request body. |
Response body: UserGroup
| Property Name | Type | Description |
|---|---|---|
| Value | string | UserGroup name |
| Tooltip | string | Tooltip or other description |
| Id | int32 | Primary key |
| Rank | int32 | Rank order |
| Deleted | bool | Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
PUT /api/v1/List/UserGroup/Items/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"Value": "eligendi",
"Tooltip": "aut",
"Id": 699,
"Rank": 889,
"Deleted": false
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Value": "corporis",
"Tooltip": "in",
"Id": 482,
"Rank": 363,
"Deleted": true,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 874
}
}
}