Get a list of groups in LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/groups
Request
Path Parameters
-
learnCenterId(required): number
Unique identifier for LearnCenter.
Query Parameters
-
limit: integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset: integer
Specify starting point of the response.Default Value:
0
-
totalResults: boolean
If set to true, payload includes total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.
Response
Supported Media Types
- application/json
200 Response
Groups collection fetched.
Root Schema : GroupsResponse
Type:
object
The groups response object.
Show Source
-
count:
number
User count for the group.
-
hasMore:
boolean
True indicates that we have more records to be displayed.
-
items:
array items
-
limit:
number
Number of Items returned in a payload. Is lower than server default limit size.
-
links:
array links
Link to the group mapped item.
Example:
{
"items":[
{
"id":766,
"name":"ck test group",
"parentGroupId":546,
"statusFlag":"inactive",
"code":"481bacda-dc63-4d92-8a08-12f807eab82d",
"activeFromDate":"2017-05-06T00:00:00",
"activeUntilDate":"2017-06-06T00:00:00",
"createdDate":"2013-06-17T18:27:01.843",
"createdBy":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/users/112867"
}
]
},
"createdByUserId":112867,
"lastUpdatedDate":"2018-03-20T05:00:01.553",
"lastUpdatedBy":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/users/1000"
}
]
},
"lastUpdatedByUserId":1000,
"onlyAllowOwnersToEditGroup":false,
"selfServiceOptions":"doesNotRequireApprovals",
"owners":{
"items":[
{
"id":112867,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
}
]
}
],
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
}
]
},
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766"
}
]
},
{
"...":null
}
],
"limit":100,
"count":34,
"hasMore":false,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups"
}
]
}
Nested Schema : GroupResponse
Type:
Show Source
object
-
activeFromDate:
string(datetime)
The created group will be active from the specified date.
-
activeUntilDate:
string(datetime)
The created group will be active until the specified date.
-
code:
string
Each group has a unique code. You can keep the default code generated automatically by LearnCenter, or optionally type a new Code for the Dynamic Group.
-
createdBy:
array createdBy
Who the group is created by.
-
createdByUserId:
number
User Id of the person who created the group.
-
createdDate:
string(datetime)
The date the group is created on.
-
id:
number
Unique Identifier of the group.
-
lastUpdatedBy:
array lastUpdatedBy
The user who last updated the group.
-
lastUpdatedByUserId:
number
The user id of the person who last updated the group.
-
lastUpdatedDate:
string(datetime)
The date the group was last updated on.
-
links:
array links
Link to the User Group Item.
-
name:
string
Name of the group.
-
onlyAllowOwnersToEditGroup:
boolean
Default Value:
true
Indicates that only Group owners have the ability to make changes to the Dynamic Group properties. -
owners:
array owners
An array of the the owners assigned to the group.
-
parentGroupId:
number
Unique Identifier of the parent group this group belongs to.
-
selfServiceOptions:
string
Allowed Values:
[ "open", "doesNotRequireApprovals", "requiresApproval" ]
What you specify here will determine whether Users can join Dynamic Groups if you provide the option to join on the dynamic object. Enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval. -
statusFlag:
string
Allowed Values:
[ "active", "inactive" ]
Status of the Group. Enum for statusFlag are: active, inactive.
Example:
{
"id":766,
"name":"ck test group",
"parentGroupId":546,
"statusFlag":"inactive",
"code":"481bacda-dc63-4d92-8a08-12f807eab82d",
"activeFromDate":"2017-05-06T00:00:00",
"activeUntilDate":"2017-06-06T00:00:00",
"createdDate":"2013-06-17T18:27:01.843",
"createdBy":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/users/112867"
}
]
},
"createdByUserId":112867,
"lastUpdatedDate":"2018-03-20T05:00:01.553",
"lastUpdatedBy":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/users/1000"
}
]
},
"lastUpdatedByUserId":1000,
"onlyAllowOwnersToEditGroup":false,
"selfServiceOptions":"doesNotRequireApprovals",
"owners":{
"items":[
{
"id":112867,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
}
]
}
],
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
}
]
},
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766"
}
]
}
Nested Schema : createdBy
Type:
array
Who the group is created by.
Show Source
-
Array of:
object UserLinkItem
Object of the User Link Item.
Nested Schema : lastUpdatedBy
Type:
array
The user who last updated the group.
Show Source
-
Array of:
object UserLinkItem
Object of the User Link Item.
Nested Schema : links
Type:
array
Link to the User Group Item.
Show Source
-
Array of:
object GroupLinkItem
Link to a group item.
Nested Schema : owners
Type:
array
An array of the the owners assigned to the group.
Show Source
-
Array of:
object GroupOwnerLinkItem
Link to the list of group owners.
Nested Schema : UserLinkItem
Type:
object
Object of the User Link Item.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/users/456
-
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
Nested Schema : GroupLinkItem
Type:
object
Link to a group item.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
-
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}
Nested Schema : GroupOwnerLinkItem
Type:
object
Link to the list of group owners.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
-
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
}
401 Response
500 Response
Internal server error.