Create a new user Custom Field.
post
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId(required): number
Unique identifier of a LearnCenter.
Custom field object that has to be created.
Root Schema : User Custom Fields
Type:
Show Source
object
-
defaultValue:
string
Default Value:User custom field default value.Example:
n/a
-
elementOptions:
array elementOptions
User custom field comprising the element options.
-
elementShowSelectOne:
boolean
Default Value:
false
User custom field element show select one.Example:false
-
elementType(required):
string
Default Value:
textbox
User custom field element type.Example:radio
-
name(required):
string
User custom field name.Example:
User Custom Field 102
- sharedFlag: boolean
-
status:
string
Default Value:
active
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 : UserCustomFieldElementOptionsLinkItem
Type:
Show Source
object
-
isDefault:
boolean
Example:
false
-
value:
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:
string
User custom field default value.Example:
n/a
-
displayOrder:
number
User custom field display order.Example:
15
-
elementOptions:
array elementOptions
User custom field comprising the element options.
-
elementShowSelectOne:
boolean
User custom field element show select one.Example:
false
-
elementType:
string
User custom field element type.Example:
radio
-
id:
number
Unique Identifier of the user custom field.Example:
102
-
learnCenter:
object learnCenter
LearnCenter object comprising the LearnCenter links.
-
learnCenterId:
string
Unique Identifier of the LearnCenter.Example:
178784
-
links:
object UserCustomFieldLinkItem
-
name:
string
User custom field name.Example:
User Custom Field 102
- sharedFlag: boolean
-
status:
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:
boolean
Example:
false
-
value:
string
Example:
first value
Nested Schema : LearnCenterLinkItem
Type:
Show Source
object
-
href:
string
Example:
{url}/learn.rest/v1/learncenters/178784
-
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178784"
}
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.