Get a list of items mapped to a group in LearnCenter.
get
/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems
Request
Path Parameters
-
groupId: number
Unique identifier of a Group.
-
learnCenterId: number
Unique identifier of a LearnCenter.
Query Parameters
-
limit(optional): integer
Specify how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify starting point of the response.Default Value:
0
-
totalResults(optional): boolean
If set to true, payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.
Response
Supported Media Types
- application/json
200 Response
Group owners collection fetched.
Root Schema : GroupMappedItemsResponse
Type:
object
Response object for group mapped items.
Show Source
-
count(optional):
number
Count is the current number of records displayed in the response.
-
hasMore(optional):
boolean
True indicates that we have more records to be displayed.
-
items(optional):
object GroupMappedItemResponse
Response object for a group mapped item.
-
limit(optional):
number
Limit implies the maximum number of records which can be displayed in the page.
-
links(optional):
array links
Example:
{
"items":[
{
"groupId":932,
"group":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932"
}
]
},
"itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37",
"itemType":"learningPlan",
"itemName":"Name of the item",
"retainMapping":false
},
{
"...":null
}
],
"limit":100,
"count":1,
"hasMore":false,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932/mappedItems"
}
]
}
Nested Schema : GroupMappedItemResponse
Type:
object
Response object for a group mapped item.
Show Source
-
group(optional):
object group
-
groupId(optional):
number
-
itemId(optional):
string
-
itemName(optional):
string
-
itemType(optional):
string
-
retainMapping(optional):
boolean
Example:
[
{
"groupId":932,
"group":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932"
}
]
},
"itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37",
"itemType":"learningPlan",
"itemName":"Name of the item",
"retainMapping":false
}
]
Nested Schema : GroupLinkItem
Type:
object
Link to a group item.
Show Source
-
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"
}
401 Response
500 Response
Internal server error.