Get learnCenters
get
/learn.rest/v1/learnCenters
Returns LearnCenters.
Request
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 the starting point of the response.Default Value:
0
-
q(required): string
Search through LearnCenters collection items. Use Mongo DB Query format. Searchable properties are - name, path. example: ?q={path:{$eq: 'home/api'}}
-
totalResults: 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.
Response
Supported Media Types
- application/json
200 Response
LearnCenters collection fetched.
Root Schema : LearnCentersResponse
Type:
object
LearnCenter response object.
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:
array items
Learn Center items.
-
limit:
number
Limit implies the maximum number of records which can be displayed in the page.
-
links:
array links
Nested Schema : links
Type:
Show Source
array
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:
Show Source
object
-
description:
string
Example:
Description of the LearnCenter
-
id:
number
Example:
178000
-
links:
array links
Link to the Learn Center.
-
memberships:
object memberships
Object containing parameters to the LearnCenter Memberships.
-
name:
string
Name of the LearnCenter.Example:
Name of LearnCenter
-
path:
string
Path to the LearnCenter.Example:
home/xyz
-
publicFlag:
string
Specifies whether the LearnCenter items are public.Example:
false
-
status:
string
Status of the LearnCenter item.Example:
active
-
supervisorAccounts:
object supervisorAccounts
Supervisor Account object containing links to the supervisor accounts.
-
url:
string
URL of the LearnCenter.Example:
{url}/xyz
-
userCustomFields:
object userCustomFields
User custom field object containing links to the custom fields.
Nested Schema : links
Type:
array
Link to the Learn Center.
Show Source
-
Array of:
object LearnCenterLink
Object containing Learn Center Links.
Nested Schema : memberships
Type:
object
Object containing parameters to the LearnCenter Memberships.
Show Source
Nested Schema : supervisorAccounts
Type:
object
Supervisor Account object containing links to the supervisor accounts.
Show Source
Nested Schema : userCustomFields
Type:
object
User custom field object containing links to the custom fields.
Show Source
Nested Schema : LearnCenterLink
Type:
object
Object containing Learn Center Links.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
rel:
string
Example:
canonical
Nested Schema : links
Type:
Show Source
array
-
Array of:
object LearnCenterMembershipsLink
Object containing Learn Center membership links.
Nested Schema : LearnCenterMembershipsLink
Type:
object
Object containing Learn Center membership links.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships
-
rel:
string
Example:
canonical
Nested Schema : links
Type:
Show Source
array
-
Array of:
object SupervisorAccountsLink
Object containing supervisor account links.
Nested Schema : SupervisorAccountsLink
Type:
object
Object containing supervisor account links.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts
-
rel:
string
Example:
canonical
Nested Schema : links
Type:
Show Source
array
-
Array of:
object LearnCenterUserCustomFieldsLink
LearnCenter user custom fields object.
Nested Schema : LearnCenterUserCustomFieldsLink
Type:
object
LearnCenter user custom fields object.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409/userCustomFields
-
rel:
string
Example:
canonical
401 Response
500 Response
Internal server error.