Update all properties of a group
put
/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
Request
Supported Media Types
- application/json
Path Parameters
-
groupId: number
Unique identifier of a group.
-
learnCenterId: number
Unique identifier of LearnCenter.
Group object that needs to be updated.
Root Schema : GroupRequest
Type:
Show Source
object
-
activeFromDate(optional):
string(date-time)
-
activeUntilDate(optional):
string(date-time)
-
code(optional):
string
-
groupname:
string
Maximum Length:
50
name of the group -
onlyAllowOwnersToEditGroup(optional):
boolean
Default Value:
true
-
owners(optional):
array owners
-
parentgroupid(optional):
number
id of the parent group
-
selfServiceOptions(optional):
Allowed Values:
[ "private", "requiresApproval", "doesNotRequireApprovals" ]
-
statusFlag(optional):
string
Allowed Values:
[ "inactive", "active" ]
status of group
Example:
{
"name":"ck test group test 123",
"parentGroupId":766,
"statusFlag":"active",
"code":"481werfa-dc63-4d92-8a08-12f807eab82d",
"activeFromDate":"2017-05-06T00:00:00",
"activeUntilDate":"2017-06-06T00:00:00",
"createdDate":"2013-06-17T18:27:01.843",
"createdByUserId":113458,
"lastUpdatedDate":"2018-03-20T05:00:01.553",
"lastUpdatedByUserId":1000,
"onlyAllowOwnersToEditGroup":false,
"selfServiceOptions":"doesNotRequireApprovals",
"owners":[
113458,
112898
]
}
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
Resource updated.
400 Response
Request has incorrect syntax or does not contain a field that is required.
401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
404 Response
Resource not found.
422 Response
Request may contain validation errors.
500 Response
Internal server error.