core_v2_userProfileField Script API

Ben Tiedt — Wed, 20 Nov 2019 14:55:14 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:55:14

Enables scripted content fragments to use User Profile Fields

Properties
Create
Delete
DynamicFormXml
Get
List
Update

Properties

Name	Access	Type	Description
ProfileFieldTypes	Read	`List of [[UserProfileFieldType Script API Type\|UserProfileFieldType]]`	List of User Profile Field Types

Methods

Create

Create a UserProfileField

Velocity

#set($userProfileFieldResponse = $core_v2_userProfileField.Create($userProfileFieldTitle, $fieldTypeId, "%{ FieldTypeChoices = $fieldTypeChoicesArg, IsSearchable = $isSearchableArg }"))

JavaScript

var userProfileFieldResponse = core_v2_userProfileField.Create(userProfileFieldTitle, fieldTypeId, { FieldTypeChoices: fieldTypeChoicesArg, IsSearchable: isSearchableArg });

Parameters

Name	Type	Description	Required
userProfileFieldTitle	`String`	User Profile Field Title	Required
fieldTypeId	`Int32`	Field Type Id	Required
FieldTypeChoices	`String`	Profile field choices are key-value pairs set using the syntax _ProfileFieldChoices_Label=value.	Optional
IsSearchable	`Boolean`	Searchability	Optional

Returns

[[UserProfileField Script API Type|UserProfileField]]

Delete

Delete a UserProfileField

Velocity

#set($additionalInfoResponse = $core_v2_userProfileField.Delete($userProfileFieldName))

JavaScript

var additionalInfoResponse = core_v2_userProfileField.Delete(userProfileFieldName);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`String`	User Profile Field Name	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

DynamicFormXml

DynamicFormXml Overload 1

Get all the properties for a UserProfileField as Dynamic Configuration XML

Velocity

#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName))

JavaScript

var stringResponse = core_v2_userProfileField.DynamicFormXml(userProfileFieldName);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`String`	User Profile Field Name	Required

DynamicFormXml Overload 2

Get all the properties for a UserProfileField as Dynamic Configuration XML

Velocity

#set($stringResponse = $core_v2_userProfileField.DynamicFormXml($userProfileFieldName, "%{ OrderNumber = $orderNumberArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_userProfileField.DynamicFormXml(userProfileFieldName, { OrderNumber: orderNumberArg, ReadOnly: readOnlyArg });

Parameters

Name	Type	Description	Required
userProfileFieldName	`String`	User Profile Field Name	Required
OrderNumber	`Int32`	Order Number	Optional
ReadOnly	`Boolean`	Read Only	Optional

Returns

String

Get

Get a UserProfileField

Velocity

#set($userProfileFieldResponse = $core_v2_userProfileField.Get($userProfileFieldName))

JavaScript

var userProfileFieldResponse = core_v2_userProfileField.Get(userProfileFieldName);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldName	`String`	User Profile Field Name	Required

Returns

[[UserProfileField Script API Type|UserProfileField]]

List

List Overload 1

List UserProfileFields

Velocity

#set($pagedListResponse = $core_v2_userProfileField.List())

JavaScript

var pagedListResponse = core_v2_userProfileField.List();

List Overload 2

List UserProfileFields

Velocity

#set($pagedListResponse = $core_v2_userProfileField.List("%{ IsSearchable = $isSearchableArg, UserProfileFieldGroupId = $userProfileFieldGroupIdArg }"))

JavaScript

var pagedListResponse = core_v2_userProfileField.List({ IsSearchable: isSearchableArg, UserProfileFieldGroupId: userProfileFieldGroupIdArg });

Parameters

Name	Type	Description	Required	Default	Options
IsSearchable	`Boolean`	Searchability	Optional
UserProfileFieldGroupId	`Int32`	Profile field group to filter by	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[UserProfileField Script API Type|UserProfileField]]

Update

Update a UserProfileField

Velocity

#set($userProfileFieldResponse = $core_v2_userProfileField.Update($userProfileFieldName, "%{ FieldTypeChoices = $fieldTypeChoicesArg, FieldTypeId = $fieldTypeIdArg, IsSearchable = $isSearchableArg, Title = $titleArg }"))

JavaScript

var userProfileFieldResponse = core_v2_userProfileField.Update(userProfileFieldName, { FieldTypeChoices: fieldTypeChoicesArg, FieldTypeId: fieldTypeIdArg, IsSearchable: isSearchableArg, Title: titleArg });

Parameters

Name	Type	Description	Required
userProfileFieldName	`String`	User Profile Field Name	Required
FieldTypeChoices	`String`	Profile field choices are key-value pairs set using the syntax _FieldTypeChoices_Label=value.	Optional
FieldTypeId	`Int32`	Profile field type	Optional
IsSearchable	`Boolean`	Searchability	Optional
Title	`String`	Profile field title	Optional

Returns

[[UserProfileField Script API Type|UserProfileField]]