Jump to

• Request
• Response

Get learnCenters

get

/learn.rest/v1/learnCenters

Returns LearnCenters.

Request

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 the starting point of the response.

  Default Value: 0
• q: string
  Search through LearnCenters collection items. Use Mongo DB Query format. Searchable properties are - name, path. example: ?q={path:{$eq: 'home/api'}}
• totalResults(optional): boolean
  If set to true, the payload includes 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

LearnCenters collection fetched.

Body ()

Root Schema : LearnCentersResponse

Type: object

LearnCenter response object.

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): array items
  Learn Center items.
• limit(optional): number
  Limit implies the maximum number of records which can be displayed in the page.
• links(optional): array links

{
    "type":"object",
    "description":"LearnCenter response object.",
    "properties":{
        "items":{
            "type":"array",
            "description":"Learn Center items.",
            "items":{
                "$ref":"#/definitions/LearnCenterResponse"
            }
        },
        "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":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/learnCenters"
                },
                {
                    "rel":"first",
                    "href":"{url}/v1/learnCenters?limit=100&offset=0"
                },
                {
                    "rel":"prev",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
                },
                {
                    "rel":"next",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
                },
                {
                    "rel":"last",
                    "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Learn Center items.

Show Source

• Array of: object LearnCenterResponse

{
    "type":"array",
    "description":"Learn Center items.",
    "items":{
        "$ref":"#/definitions/LearnCenterResponse"
    }
}

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":"{url}/learn.rest/v1/learnCenters"
        },
        {
            "rel":"first",
            "href":"{url}/v1/learnCenters?limit=100&offset=0"
        },
        {
            "rel":"prev",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
        },
        {
            "rel":"next",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
        },
        {
            "rel":"last",
            "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters"
    },
    {
        "rel":"first",
        "href":"{url}/v1/learnCenters?limit=100&offset=0"
    },
    {
        "rel":"prev",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0"
    },
    {
        "rel":"next",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10"
    },
    {
        "rel":"last",
        "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200"
    }
]

Nested Schema : LearnCenterResponse

Type: object

Show Source

• description(optional): string
  Example: Description of the LearnCenter
• id(optional): number
  Example: 178000
• links(optional): array links
  Link to the Learn Center.
• memberships(optional): object memberships
  Object containing parameters to the LearnCenter Memberships.
• name(optional): string
  Name of the LearnCenter.

  Example: Name of LearnCenter
• path(optional): string
  Path to the LearnCenter.

  Example: home/xyz
• publicFlag(optional): string
  Specifies whether the LearnCenter items are public.

  Example: false
• status(optional): string
  Status of the LearnCenter item.

  Example: active
• supervisorAccounts(optional): object supervisorAccounts
  Supervisor Account object containing links to the supervisor accounts.
• url(optional): string
  URL of the LearnCenter.

  Example: {url}/xyz
• userCustomFields(optional): object userCustomFields
  User custom field object containing links to the custom fields.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":178000
        },
        "name":{
            "type":"string",
            "description":"Name of the LearnCenter.",
            "example":"Name of LearnCenter"
        },
        "description":{
            "type":"string",
            "example":"Description of the LearnCenter"
        },
        "url":{
            "type":"string",
            "example":"{url}/xyz",
            "description":"URL of the LearnCenter."
        },
        "path":{
            "type":"string",
            "example":"home/xyz",
            "description":"Path to the LearnCenter."
        },
        "publicFlag":{
            "type":"string",
            "example":false,
            "description":"Specifies whether the LearnCenter items are public."
        },
        "status":{
            "type":"string",
            "example":"active",
            "description":"Status of the LearnCenter item."
        },
        "memberships":{
            "type":"object",
            "description":"Object containing parameters to the LearnCenter Memberships.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterMembershipsLink"
                    }
                }
            }
        },
        "userCustomFields":{
            "type":"object",
            "description":"User custom field object containing links to the custom fields.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LearnCenterUserCustomFieldsLink"
                    }
                }
            }
        },
        "supervisorAccounts":{
            "type":"object",
            "description":"Supervisor Account object containing links to the supervisor accounts.",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/SupervisorAccountsLink"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Link to the Learn Center.",
            "items":{
                "$ref":"#/definitions/LearnCenterLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Link to the Learn Center.

Show Source

• Array of: object LearnCenterLink
  Object containing Learn Center Links.

{
    "type":"array",
    "description":"Link to the Learn Center.",
    "items":{
        "$ref":"#/definitions/LearnCenterLink"
    }
}

Nested Schema : memberships

Type: object

Object containing parameters to the LearnCenter Memberships.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Object containing parameters to the LearnCenter Memberships.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterMembershipsLink"
            }
        }
    }
}

Nested Schema : supervisorAccounts

Type: object

Supervisor Account object containing links to the supervisor accounts.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"Supervisor Account object containing links to the supervisor accounts.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SupervisorAccountsLink"
            }
        }
    }
}

Nested Schema : userCustomFields

Type: object

User custom field object containing links to the custom fields.

Show Source

• links(optional): array links

{
    "type":"object",
    "description":"User custom field object containing links to the custom fields.",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterUserCustomFieldsLink"
            }
        }
    }
}

Nested Schema : LearnCenterLink

Type: object

Object containing Learn Center Links.

Show Source

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

{
    "type":"object",
    "description":"Object containing Learn Center Links.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterMembershipsLink
  Object containing Learn Center membership links.

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

Nested Schema : LearnCenterMembershipsLink

Type: object

Object containing Learn Center membership links.

Show Source

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

{
    "type":"object",
    "description":"Object containing Learn Center membership links.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SupervisorAccountsLink
  Object containing supervisor account links.

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

Nested Schema : SupervisorAccountsLink

Type: object

Object containing supervisor account links.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/supervisorAccounts
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "description":"Object containing supervisor account links.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LearnCenterUserCustomFieldsLink
  LearnCenter user custom fields object.

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

Nested Schema : LearnCenterUserCustomFieldsLink

Type: object

LearnCenter user custom fields object.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/178409/userCustomFields
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "description":"LearnCenter user custom fields object.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409/userCustomFields"
        }
    }
}

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