Get a list of user Custom Fields.
get
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a Learn Center.
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
-
totalResults(optional): boolean
If set to true, the payload includes the 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/xml
- application/json
200 Response
The user custom fields collection is fetched.
Root Schema : UserCustomFieldsResponse
Type:
Show Source
object
-
count(optional):
number
Example:
100
-
hasMore(optional):
boolean
Example:
false
-
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/178409/userCustomFields"
}
]
Nested Schema : User Custom Fields
Type:
Show Source
object
-
defaultValue(optional):
string
Example:
n/a
-
elementOptions(optional):
array elementOptions
-
elementShowSelectOne(optional):
boolean
Example:
false
-
elementType(optional):
string
Example:
radio
-
id(optional):
number
Example:
123
-
learnCenter(optional):
object learnCenter
-
learnCenterId(optional):
string
Example:
178409
-
links(optional):
object UserCustomFieldLink
-
name(optional):
string
Example:
User Custom Field 1
- sharedFlag(optional): boolean
-
status(optional):
string
Allowed Values:
[ "active", "inactive" ]
Example:active
Nested Schema : learnCenter
Type:
Show Source
object
-
items(optional):
object LearnCenterLink
Object containing Learn Center Links.
Nested Schema : UserCustomFieldLink
Type:
Show Source
object
Example:
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178409/userCustomFields/102"
}
Nested Schema : UserCustomFieldElementOptionsLink
Type:
Show Source
object
-
isDefault(optional):
boolean
Example:
false
-
value(optional):
string
Example:
first value
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
401 Response
Authentication refused for provided credentials or the token is invalid.
Headers
500 Response
Internal server error.