Jump to

• Request
• Response

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.

Body ()

Custom field object that has to be created.

Root Schema : User Custom Fields

Type: object

Show Source

• 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
  Example: true
• status(optional): string
  Default Value: active

  Allowed Values: [ "active", "inactive" ]

  Example: active

{
    "type":"object",
    "required":[
        "name",
        "elementType"
    ],
    "properties":{
        "name":{
            "type":"string",
            "example":"User Custom Field 1"
        },
        "defaultValue":{
            "type":"string",
            "default":"",
            "example":"n/a"
        },
        "elementType":{
            "type":"string",
            "default":"textbox",
            "example":"radio"
        },
        "elementShowSelectOne":{
            "type":"boolean",
            "default":false,
            "example":false
        },
        "elementOptions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserCustomFieldElementOptionsLink"
            }
        },
        "sharedFlag":{
            "type":"boolean",
            "example":true
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "default":"active",
            "example":"active"
        }
    },
    "xml":{
        "name":"User Custom Fields"
    }
}

Nested Schema : elementOptions

Type: array

Show Source

• Array of: object UserCustomFieldElementOptionsLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserCustomFieldElementOptionsLink"
    }
}

Nested Schema : UserCustomFieldElementOptionsLink

Type: object

Show Source

• isDefault(optional): boolean
  Example: false
• value(optional): string
  Example: first value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"first value"
        },
        "isDefault":{
            "type":"boolean",
            "example":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

New user Custom Field resource created.

Body ()

Root Schema : User Custom Fields

Type: object

Show Source

• 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
  Example: true
• status(optional): string
  Allowed Values: [ "active", "inactive" ]

  Example: active

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":123
        },
        "learnCenterId":{
            "type":"string",
            "example":178409
        },
        "learnCenter":{
            "type":"object",
            "properties":{
                "items":{
                    "$ref":"#/definitions/LearnCenterLink"
                }
            }
        },
        "name":{
            "type":"string",
            "example":"User Custom Field 1"
        },
        "defaultValue":{
            "type":"string",
            "example":"n/a"
        },
        "elementType":{
            "type":"string",
            "example":"radio"
        },
        "elementShowSelectOne":{
            "type":"boolean",
            "example":false
        },
        "elementOptions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserCustomFieldElementOptionsLink"
            }
        },
        "sharedFlag":{
            "type":"boolean",
            "example":true
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "example":"active"
        },
        "links":{
            "$ref":"#/definitions/UserCustomFieldLink"
        }
    },
    "xml":{
        "name":"User Custom Fields"
    }
}

Nested Schema : elementOptions

Type: array

Show Source

• Array of: object UserCustomFieldElementOptionsLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserCustomFieldElementOptionsLink"
    }
}

Nested Schema : learnCenter

Type: object

Show Source

• items(optional): object LearnCenterLink
  Object containing Learn Center Links.

{
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/LearnCenterLink"
        }
    }
}

Nested Schema : UserCustomFieldLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/memberships/6597/customFieldValues
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/memberships/6597/customFieldValues"
        }
    }
}

Nested Schema : UserCustomFieldElementOptionsLink

Type: object

Show Source

• isDefault(optional): boolean
  Example: false
• value(optional): string
  Example: first value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"first value"
        },
        "isDefault":{
            "type":"boolean",
            "example":false
        }
    }
}

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

{
    "type":"object",
    "description":"Object containing Learn Center Links.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/178409"
        }
    }
}

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.

Back to Top