Get group details by group id.
get
/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
Request
Path Parameters
-
groupId: number
Unique identifier of a group.
-
learnCenterId: number
Unique identifier of LearnCenter.
Response
Supported Media Types
- application/json
200 Response
Group fetched.
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