CreateCustomField
Adds a new custom field component to your organization.
Input
Name | Type | Description |
Label | String | Label for the field. |
ObjectName | String | Name for the parent object. |
FieldName | String | Name for the new custom field. |
Type | String | Type of the field.
The allowed values are Checkbox, Currency, Date, DateTime, Time, Email, Location, Number, Percent, Phone, Picklist, MultiselectPicklist, Text, TextArea, LongTextArea, Url, EncryptedText. |
Description | String | Description of the field. |
Required | Boolean | Indicates whether the field requires a value on creation. |
Unique | Boolean | Indicates whether the field is unique. |
ExternalId | Boolean | Indicates whether the field is an external ID field. |
DefaultValue | String | Represents the default value of the field. |
Length | Integer | Length of the field. |
Precision | Integer | The precision for number values. Precision is the number of digits in a number. |
Scale | Integer | The scale for the field. Scale is the number of digits to the right of the decimal point in a number. For example, the number 256.99 has a scale of 2. |
ValueSet | String | Represents the set of values that make up a picklist on a custom field. |
VisibleLines | Integer | Indicates the number of lines displayed for the field. |
MaskType | String | For encrypted text fields, specifies the format of the masked and unmasked characters in the field.
The allowed values are all, creditCard, lastFour, nino, sin, ssn. |
MaskChar | String | For encrypted fields, specifies the character to be used as a mask.
The allowed values are asterisk, X. |
Result Set Columns
Name | Type | Description |
FullName | String | The FullName of the field. |
Success | String | If the store procedure has succeeded or not. |