Create a new user Custom Field.
post
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
Custom field object that has to be created.
Root Schema : User Custom Fields
Type:
Show Source
object
-
defaultValue(optional):
string
Default Value:Example:
n/a
-
elementOptions(optional):
array elementOptions
-
elementShowSelectOne(optional):
boolean
Default Value:
false
Example:false
-
elementType:
string
Default Value:
textbox
Example:radio
-
name:
string
Example:
User Custom Field 1
- sharedFlag(optional): boolean
-
status(optional):
string
Default Value:
active
Allowed Values:[ "active", "inactive" ]
Example:active
Nested Schema : UserCustomFieldElementOptionsLink
Type:
Show Source
object
-
isDefault(optional):
boolean
Example:
false
-
value(optional):
string
Example:
first value
Response
Supported Media Types
- application/xml
- application/json
201 Response
New user Custom Field resource created.
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 : 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:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/178409
-
rel(optional):
string
Example:
canonical
400 Response
Request has incorrect syntax or does not contain a field that is required.
409 Response
Another resource with the same identifier already exists.
422 Response
Request may contain validation errors.
500 Response
Internal server error.