Jump to

• Request
• Response

Get a list of items mapped to a group in LearnCenter.

get

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Request

Path Parameters

• groupId(required): number
  Unique identifier of a Group.
• learnCenterId(required): number
  Unique identifier of a 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 the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Group owners collection fetched.

Body ()

Root Schema : GroupMappedItemsResponse

Type: object

Response object for group mapped items.

Show Source

• count: number
  Count is the current number of records displayed in the response.
• hasMore: boolean
  True indicates that we have more records to be displayed.
• items: object GroupMappedItemResponse
  Response object for a group mapped item.
• limit: number
  Limit implies the maximum number of records which can be displayed in the page.
• links: array links

{
    "description":"Response object for group mapped items.",
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/GroupMappedItemResponse"
        },
        "limit":{
            "type":"number",
            "description":"Limit implies the maximum number of records which can be displayed in the page."
        },
        "count":{
            "type":"number",
            "description":"Count is the current number of records displayed in the response."
        },
        "hasMore":{
            "type":"boolean",
            "description":" True indicates that we have more records to be displayed."
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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: object group
• groupId: number
• itemId: string
• itemName: string
• itemType: string
• retainMapping: boolean

{
    "description":"Response object for a group mapped item.",
    "type":"object",
    "properties":{
        "groupId":{
            "type":"number"
        },
        "group":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GroupLinkItem"
                    }
                }
            }
        },
        "itemId":{
            "type":"string"
        },
        "itemType":{
            "type":"string"
        },
        "itemName":{
            "type":"string"
        },
        "retainMapping":{
            "type":"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
        }
    ]
}

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 : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : group

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLinkItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object GroupLinkItem
  Link to a group item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupLinkItem"
    }
}

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

{
    "description":"Link to a group item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}

Nested Schema : items

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top