Get a LearnCenter
get
/learn.rest/v1/learnCenters/{learnCenterId}
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
LearnCenter details fetched.
Root Schema : LearnCenterResponse
Type:
Show Source
object
-
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.
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(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
rel(optional):
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(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships
-
rel(optional):
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(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts
-
rel(optional):
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(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409/userCustomFields
-
rel(optional):
string
Example:
canonical
401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
404 Response
Resource not found.
500 Response
Internal server error.