Creates a new group
post
/learn.rest/v1/learnCenters/{learnCenterId}/groups
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
Group object that needs to be created.
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
201 Response
New group resource created.
Root Schema : GroupResponse
Type:
Show Source
object
-
activeFromDate(optional):
string(datetime)
Example:
2017-05-06T00:00:00
-
activeUntilDate(optional):
string(datetime)
Example:
2017-06-06T00:00:00
-
code(optional):
string
Example:
481bacda-dc63-4d92-8a08-12f807eab82d
-
createdBy(optional):
array createdBy
-
createdByUserId(optional):
number
Example:
123123
-
createdDate(optional):
string(datetime)
Example:
2013-06-17T18:27:01.843
-
id(optional):
number
Example:
766
-
lastUpdatedBy(optional):
array lastUpdatedBy
-
lastUpdatedByUserId(optional):
number
Example:
123123
-
lastUpdatedDate(optional):
string(datetime)
Example:
2018-03-20T05:00:01.553
-
links(optional):
array links
-
name(optional):
string
Example:
my group
-
onlyAllowOwnersToEditGroup(optional):
boolean
Example:
true
-
owners(optional):
array owners
-
parentGroupId(optional):
number
Example:
123
-
selfServiceOptions(optional):
string
Allowed Values:
[ "open", "doesNotRequireApprovals", "requiresApproval" ]
enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApprovalExample:open
-
statusFlag(optional):
string
Allowed Values:
[ "active", "inactive" ]
enum for statusFlag are: active, inactiveExample:active
Nested Schema : UserLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Nested Schema : GroupLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}
Nested Schema : GroupOwnerLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
-
rel(optional):
string
Example:
canonical
400 Response
Request has incorrect syntax or does not contain a field that is required.
409 Response
Another resource with the same identifier already exists.
500 Response
Internal server error.