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
User custom field count.Example:
100
-
hasMore(optional):
boolean
True Indicates that we have more records to be displayed.Example:
false
-
items(optional):
array items
-
limit(optional):
number
Number of Items returned in a payload. Is lower than server default limit size.Example:
100
-
links(optional):
array links
Link to the user custom field mapped item.
Nested Schema : links
Type:
array
Link to the user custom field mapped item.
Show Source
Example:
[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/178784/userCustomFields"
}
]
Nested Schema : User Custom Fields
Type:
Show Source
object
-
defaultValue(optional):
string
User custom field default value.Example:
n/a
-
displayOrder(optional):
number
User custom field display order.Example:
15
-
elementOptions(optional):
array elementOptions
User custom field comprising the element options.
-
elementShowSelectOne(optional):
boolean
User custom field element show select one.Example:
false
-
elementType(optional):
string
User custom field element type.Example:
radio
-
id(optional):
number
Unique Identifier of the user custom field.Example:
102
-
learnCenter(optional):
object learnCenter
LearnCenter object comprising the LearnCenter links.
-
learnCenterId(optional):
string
Unique Identifier of the LearnCenter.Example:
178784
-
links(optional):
object UserCustomFieldLinkItem
-
name(optional):
string
User custom field name.Example:
User Custom Field 102
- sharedFlag(optional): boolean
-
status(optional):
string
Allowed Values:
[ "active", "inactive" ]
User custom field status.Example:active
Nested Schema : elementOptions
Type:
array
User custom field comprising the element options.
Show Source
Nested Schema : learnCenter
Type:
object
LearnCenter object comprising the LearnCenter links.
Show Source
Nested Schema : UserCustomFieldLinkItem
Type:
Show Source
object
Example:
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178784/userCustomFields/102"
}
Nested Schema : UserCustomFieldElementOptionsLinkItem
Type:
Show Source
object
-
isDefault(optional):
boolean
Example:
false
-
value(optional):
string
Example:
first value
Nested Schema : LearnCenterLinkItem
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learncenters/178784
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178784"
}
401 Response
500 Response
Internal server error.