Get a user Custom Field.
get
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}
Request
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
-
userCustomFieldId: number
Unique identifier of a User Custom Field definition.
Response
Supported Media Types
- application/xml
- application/json
200 Response
User role is fetched.
Root 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
404 Response
Resource not found.
500 Response
Internal server error.