Jump to

• Request
• Response

Update all properties of a user Custom Field.

put

/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• userCustomFieldId: number
  Unique identifier of a User Custom Field definition.

Body ()

Custom field object that needs to be updated.

Root Schema : User Custom Fields

Type: object

Show Source

• defaultValue(optional): string
  Default Value:

  User custom field default value.

  Example: n/a
• elementOptions(optional): array elementOptions
  User custom field comprising the element options.
• elementShowSelectOne(optional): boolean
  Default Value: false

  User custom field element show select one.

  Example: false
• elementType: string
  Default Value: textbox

  User custom field element type.

  Example: radio
• name: string
  User custom field name.

  Example: User Custom Field 102
• sharedFlag(optional): boolean
  User custom field shared flag.

  Example: true
• status(optional): string
  Default Value: active

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

  User custom field status.

  Example: active

{
    "type":"object",
    "required":[
        "name",
        "elementType"
    ],
    "properties":{
        "name":{
            "type":"string",
            "example":"User Custom Field 102",
            "description":"User custom field name."
        },
        "defaultValue":{
            "type":"string",
            "default":"",
            "example":"n/a",
            "description":"User custom field default value."
        },
        "elementType":{
            "type":"string",
            "default":"textbox",
            "example":"radio",
            "description":"User custom field element type."
        },
        "elementShowSelectOne":{
            "type":"boolean",
            "default":false,
            "example":false,
            "description":"User custom field element show select one."
        },
        "elementOptions":{
            "type":"array",
            "description":"User custom field comprising the element options.",
            "items":{
                "$ref":"#/definitions/UserCustomFieldElementOptionsLinkItem"
            }
        },
        "sharedFlag":{
            "type":"boolean",
            "example":true,
            "description":"User custom field shared flag."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "default":"active",
            "example":"active",
            "description":"User custom field status."
        }
    },
    "xml":{
        "name":"User Custom Fields"
    }
}

Nested Schema : elementOptions

Type: array

User custom field comprising the element options.

Show Source

• Array of: object UserCustomFieldElementOptionsLinkItem

{
    "type":"array",
    "description":"User custom field comprising the element options.",
    "items":{
        "$ref":"#/definitions/UserCustomFieldElementOptionsLinkItem"
    }
}

Nested Schema : UserCustomFieldElementOptionsLinkItem

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
        }
    }
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Resource updated.

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

500 Response

Internal server error.

Back to Top