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.
Response
Supported Media Types
- application/json
200 Response
LearnCenters collection fetched.
Root Schema : LearnCentersResponse
Type:
Show Source
object
-
count(optional):
number
Example:
100
-
hasMore(optional):
boolean
Example:
true
-
items(optional):
array items
-
limit(optional):
number
Example:
100
-
links(optional):
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(optional):
string
Example:
Description of LearnCenter
-
id(optional):
number
Example:
178000
-
links(optional):
array links
-
memberships(optional):
object memberships
-
name(optional):
string
Name of the LearnCenterExample:
Name of LearnCenter
-
path(optional):
string
Example:
home/xyz
-
publicFlag(optional):
string
Example:
false
-
status(optional):
string
Example:
active
-
supervisorAccounts(optional):
object supervisorAccounts
-
url(optional):
string
Example:
{url}/xyz
-
userCustomFields(optional):
object userCustomFields
Nested Schema : LearnCenterLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
rel(optional):
string
Example:
canonical
Nested Schema : LearnCenterMembershipsLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships
-
rel(optional):
string
Example:
canonical
Nested Schema : SupervisorAccountsLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts
-
rel(optional):
string
Example:
canonical
Nested Schema : LearnCenterUserCustomFieldsLink
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/userCustomFields
-
rel(optional):
string
Example:
canonical
401 Response
500 Response
Internal server error.