Jump to

• Request
• Response

Get a list of user Custom Fields.

get

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

Request

Path Parameters

• learnCenterId: number
  Unique identifier of a Learn Center.

Query Parameters

• limit(optional): integer
  Specify how many items should be returned in a payload. Must be lower than server default limit size.
• offset(optional): integer
  Specify the starting point of the response.

  Default Value: 0
• totalResults(optional): boolean
  If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the last link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The user custom fields collection is fetched.

Body ()

Root Schema : UserCustomFieldsResponse

Type: object

Show Source

• count(optional): number
  User custom field count.

  Example: 100
• hasMore(optional): boolean
  True Indicates that we have more records to be displayed.

  Example: false
• items(optional): array items
• limit(optional): number
  Number of Items returned in a payload. Is lower than server default limit size.

  Example: 100
• links(optional): array links
  Link to the user custom field mapped item.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserCustomFieldResponse"
            }
        },
        "limit":{
            "type":"number",
            "example":100,
            "description":"Number of Items returned in a payload. Is lower than server default limit size."
        },
        "count":{
            "type":"number",
            "example":100,
            "description":"User custom field count."
        },
        "hasMore":{
            "type":"boolean",
            "example":false,
            "description":"True Indicates that we have more records to be displayed."
        },
        "links":{
            "description":"Link to the user custom field mapped item.",
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/learnCenters/178784/userCustomFields"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object User Custom Fields

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

Nested Schema : links

Type: array

Link to the user custom field mapped item.

Show Source

• Array of: object items

{
    "description":"Link to the user custom field mapped item.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/learnCenters/178784/userCustomFields"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters/178784/userCustomFields"
    }
]

Nested Schema : User Custom Fields

Type: object

Show Source

• defaultValue(optional): string
  User custom field default value.

  Example: n/a
• displayOrder(optional): number
  User custom field display order.

  Example: 15
• elementOptions(optional): array elementOptions
  User custom field comprising the element options.
• elementShowSelectOne(optional): boolean
  User custom field element show select one.

  Example: false
• elementType(optional): string
  User custom field element type.

  Example: radio
• id(optional): number
  Unique Identifier of the user custom field.

  Example: 102
• learnCenter(optional): object learnCenter
  LearnCenter object comprising the LearnCenter links.
• learnCenterId(optional): string
  Unique Identifier of the LearnCenter.

  Example: 178784
• links(optional): object UserCustomFieldLinkItem
• name(optional): string
  User custom field name.

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

  Example: true
• status(optional): string
  Allowed Values: [ "active", "inactive" ]

  User custom field status.

  Example: active

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":102,
            "description":"Unique Identifier of the user custom field."
        },
        "learnCenterId":{
            "type":"string",
            "example":178784,
            "description":"Unique Identifier of the LearnCenter."
        },
        "learnCenter":{
            "description":"LearnCenter object comprising the LearnCenter links.",
            "type":"object",
            "properties":{
                "links":{
                    "$ref":"#/definitions/LearnCenterLinkItem"
                }
            }
        },
        "name":{
            "type":"string",
            "example":"User Custom Field 102",
            "description":"User custom field name."
        },
        "displayOrder":{
            "type":"number",
            "example":15,
            "description":"User custom field display order."
        },
        "defaultValue":{
            "type":"string",
            "example":"n/a",
            "description":"User custom field default value."
        },
        "elementType":{
            "type":"string",
            "example":"radio",
            "description":"User custom field element type."
        },
        "elementShowSelectOne":{
            "type":"boolean",
            "example":false,
            "description":"User custom field element show select one."
        },
        "elementOptions":{
            "description":"User custom field comprising the element options.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserCustomFieldElementOptionsLinkItem"
            }
        },
        "sharedFlag":{
            "type":"boolean",
            "example":true,
            "description":"User custom field shared flag."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "example":"active",
            "description":"User custom field status."
        },
        "links":{
            "$ref":"#/definitions/UserCustomFieldLinkItem"
        }
    },
    "xml":{
        "name":"User Custom Fields"
    }
}

Nested Schema : elementOptions

Type: array

User custom field comprising the element options.

Show Source

• Array of: object UserCustomFieldElementOptionsLinkItem

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

Nested Schema : learnCenter

Type: object

LearnCenter object comprising the LearnCenter links.

Show Source

• links(optional): object LearnCenterLinkItem

{
    "description":"LearnCenter object comprising the LearnCenter links.",
    "type":"object",
    "properties":{
        "links":{
            "$ref":"#/definitions/LearnCenterLinkItem"
        }
    }
}

Nested Schema : UserCustomFieldLinkItem

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178784/userCustomFields/102"
    }
}

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178784/userCustomFields/102"
}

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

Nested Schema : LearnCenterLinkItem

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learncenters/178784
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learncenters/178784"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learncenters/178784"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learncenters/178784"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top