Get a user Custom Field.
get
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}
Get a user Custom Field.
Request
Path Parameters
-
learnCenterId(required): number
Unique identifier of a LearnCenter.
-
userCustomFieldId(required): 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:
string
Example:
n/a
-
elementOptions:
array elementOptions
-
elementShowSelectOne:
boolean
Example:
false
-
elementType:
string
Example:
radio
-
id:
number
Example:
123
-
learnCenter:
object learnCenter
-
learnCenterId:
string
Example:
178409
-
links:
object UserCustomFieldLink
-
name:
string
Example:
User Custom Field 1
- sharedFlag: boolean
-
status:
string
Allowed Values:
[ "active", "inactive" ]
Example:active
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:
boolean
Example:
false
-
value:
string
Example:
first value
Nested Schema : LearnCenterLink
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
rel:
string
Example:
canonical
401 Response
404 Response
Resource not found.
500 Response
Internal server error.