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

Show Source

• count(optional): number
  Example: 34
• hasMore(optional): boolean
  Example: false
• items(optional): array items
• limit(optional): number
  Example: 100
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupResponse"
            }
        },
        "limit":{
            "type":"number",
            "example":100
        },
        "count":{
            "type":"number",
            "example":34
        },
        "hasMore":{
            "type":"boolean",
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "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

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups"
        }
    ]
}

Example:

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

Nested Schema : GroupResponse

Type: object

Show Source

• 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, requiresApproval

  Example: open
• statusFlag(optional): string
  Allowed Values: [ "active", "inactive" ]

  enum for statusFlag are: active, inactive

  Example: active

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":766
        },
        "name":{
            "type":"string",
            "example":"my group"
        },
        "parentGroupId":{
            "type":"number",
            "example":123
        },
        "statusFlag":{
            "type":"string",
            "description":"enum for statusFlag are: active, inactive",
            "enum":[
                "active",
                "inactive"
            ],
            "example":"active"
        },
        "code":{
            "type":"string",
            "example":"481bacda-dc63-4d92-8a08-12f807eab82d"
        },
        "activeFromDate":{
            "type":"string",
            "format":"datetime",
            "example":"2017-05-06T00:00:00"
        },
        "activeUntilDate":{
            "type":"string",
            "format":"datetime",
            "example":"2017-06-06T00:00:00"
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "example":"2013-06-17T18:27:01.843"
        },
        "createdBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        },
        "createdByUserId":{
            "type":"number",
            "example":123123
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "example":"2018-03-20T05:00:01.553"
        },
        "lastUpdatedBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "example":123123
        },
        "onlyAllowOwnersToEditGroup":{
            "type":"boolean",
            "example":true
        },
        "selfServiceOptions":{
            "type":"string",
            "description":"enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval",
            "enum":[
                "open",
                "doesNotRequireApprovals",
                "requiresApproval"
            ],
            "example":"open"
        },
        "owners":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupOwnerLink"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLink"
            }
        }
    }
}

Nested Schema : createdBy

Type: array

Show Source

• Array of: object UserLink

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

Nested Schema : lastUpdatedBy

Type: array

Show Source

• Array of: object UserLink

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

Nested Schema : links

Type: array

Show Source

• Array of: object GroupLink

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

Nested Schema : owners

Type: array

Show Source

• Array of: object GroupOwnerLink

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

Nested Schema : UserLink

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    }
}

Nested Schema : GroupLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
• rel(optional): string
  Example: canonical

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{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 the token is invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top