Jump to

• Request
• Response

Get a list of groups in LearnCenter.

get

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

Request

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Groups collection fetched.

Body ()

Root Schema : GroupsResponse

Type: object

The groups response object.

Show Source

• count(optional): number
  User count for the group.
• hasMore(optional): boolean
  True indicates that we have more records to be displayed.
• items(optional): array items
• limit(optional): number
  Number of Items returned in a payload. Is lower than server default limit size.
• links(optional): array links
  Link to the group mapped item.

{
    "description":"The groups response object.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupResponse"
            }
        },
        "limit":{
            "description":"Number of Items returned in a payload. Is lower than server default limit size.",
            "type":"number"
        },
        "count":{
            "description":"User count for the group.",
            "type":"number"
        },
        "hasMore":{
            "type":"boolean",
            "description":"True indicates that we have more records to be displayed."
        },
        "links":{
            "description":"Link to the group mapped item.",
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "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"
            }
        ]
    }
}

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

Type: array

Show Source

• Array of: object GroupResponse

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

Nested Schema : links

Type: array

Link to the group mapped item.

Show Source

• Array of: object items

{
    "description":"Link to the group mapped item.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : GroupResponse

Type: object

Show Source

• activeFromDate(optional): string(datetime)
  The created group will be active from the specified date.
• activeUntilDate(optional): string(datetime)
  The created group will be active until the specified date.
• code(optional): 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(optional): array createdBy
  Who the group is created by.
• createdByUserId(optional): number
  User Id of the person who created the group.
• createdDate(optional): string(datetime)
  The date the group is created on.
• id(optional): number
  Unique Identifier of the group.
• lastUpdatedBy(optional): array lastUpdatedBy
  The user who last updated the group.
• lastUpdatedByUserId(optional): number
  The user id of the person who last updated the group.
• lastUpdatedDate(optional): string(datetime)
  The date the group was last updated on.
• links(optional): array links
  Link to the User Group Item.
• name(optional): string
  Name of the group.
• onlyAllowOwnersToEditGroup(optional): boolean
  Default Value: true

  Indicates that only Group owners have the ability to make changes to the Dynamic Group properties.
• owners(optional): array owners
  An array of the the owners assigned to the group.
• parentGroupId(optional): number
  Unique Identifier of the parent group this group belongs to.
• selfServiceOptions(optional): 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(optional): string
  Allowed Values: [ "active", "inactive" ]

  Status of the Group. Enum for statusFlag are: active, inactive.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Unique Identifier of the group."
        },
        "name":{
            "type":"string",
            "description":"Name of the group."
        },
        "parentGroupId":{
            "type":"number",
            "description":"Unique Identifier of the parent group this group belongs to."
        },
        "statusFlag":{
            "type":"string",
            "description":"Status of the Group. Enum for statusFlag are: active, inactive.",
            "enum":[
                "active",
                "inactive"
            ]
        },
        "code":{
            "type":"string",
            "description":"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."
        },
        "activeFromDate":{
            "type":"string",
            "format":"datetime",
            "description":"The created group will be active from the specified date."
        },
        "activeUntilDate":{
            "type":"string",
            "format":"datetime",
            "description":"The created group will be active until the specified date."
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "description":"The date the group is created on."
        },
        "createdBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            },
            "description":"Who the group is created by."
        },
        "createdByUserId":{
            "type":"number",
            "description":"User Id of the person who created the group."
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "description":"The date the group was last updated on."
        },
        "lastUpdatedBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            },
            "description":"The user who last updated the group."
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "description":"The user id of the person who last updated the group."
        },
        "onlyAllowOwnersToEditGroup":{
            "type":"boolean",
            "default":true,
            "description":"Indicates that only  Group owners have the ability to make changes to the Dynamic Group properties."
        },
        "selfServiceOptions":{
            "type":"string",
            "description":"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.",
            "enum":[
                "open",
                "doesNotRequireApprovals",
                "requiresApproval"
            ]
        },
        "owners":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupOwnerLinkItem"
            },
            "description":"An array of the the owners assigned to the group."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLinkItem"
            },
            "description":"Link to the User Group Item."
        }
    },
    "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"
            }
        ]
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    },
    "description":"Who the group is created by."
}

Nested Schema : lastUpdatedBy

Type: array

The user who last updated the group.

Show Source

• Array of: object UserLinkItem
  Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    },
    "description":"The user who last updated the group."
}

Nested Schema : links

Type: array

Link to the User Group Item.

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupLinkItem"
    },
    "description":"Link to the User 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.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupOwnerLinkItem"
    },
    "description":"An array of the the owners assigned to the group."
}

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

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

{
    "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 : GroupOwnerLinkItem

Type: object

Link to the list of group owners.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
• rel(optional): string
  Example: canonical

{
    "description":"Link to the list of group owners.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
    }
}

Example:

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

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): 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