Difference between revisions of "Java API:Field Type Reference"

From AgileApps Support Wiki
imported>Aeric
(Created page with "This table shows how to format input data for the various Field Display Types in platform objects when using the Java API. {| border="1" cellpadding="5" cellspacing="0" ...")
 
imported>Aeric
 
(19 intermediate revisions by the same user not shown)
Line 8: Line 8:
| Auto Number
| Auto Number
|
|
n/a
n/a (read only)


|-
|-
Line 18: Line 18:
| Currency
| Currency
|
|
* Specify a decimal value, with no currency symbol and no separators other than the decimal point.  
* Specify a value in [[Database Format]], with no currency symbol and no separators other than the decimal point.  
 
|-
| [[Custom Control]]
|
n/a


|-
|-
Line 29: Line 24:
|
|
* A date.
* A date.
* The field definition determines how the value is stored.
* The field definition and user's [[Locale Settings]] determine how to format the value.


|-
|-
Line 35: Line 30:
|  
|  
* <span id="Date_time">A date and time.<span>
* <span id="Date_time">A date and time.<span>
* The field definition determines how the value is stored.
* The field definition and user's [[Locale Settings]] determine how to format the value.


|-
|-
| [[Dependent Picklist]]
| [[Dependent Picklist]]
|
|
n/a
* Specify one of the picklist values.
* An error is thrown if the list (determined by the parent-field dependency) doesn't include that value.


|-
|-
| Email Address  
| Email Address  
|  
|  
* A string containing text of the form ''name''@''domain''.''type''. Example: <tt>friend@somewhere.com</tt>
* A string containing text in email-address format. For example: <tt>friend@somewhere.com</tt>
 
|-
| [[External Lookup]]
|
n/a


|-
|-
| File Field  
| File Field  
|  
|  
* To upload a file, do a [[REST API:record Resource#Multipart Operations for Raw Data|Multipart]] REST request
* To upload a file, use the instructions to [[Pages#Example: Submit Data that Includes a File Attachment|Submit data that includes a File attachment]]


|-
|-
Line 56: Line 57:
|
|
n/a
n/a
|-
| Geolocation
|
A string containing a latitude and longitude, separated by a comma and a space.<br>Ex: <tt>37.403930662906106, -121.97971165820213</tt>


|-
|-
Line 65: Line 71:
| <span id="image">Image Field</span>
| <span id="image">Image Field</span>
|
|
* To upload an image, do a [[REST API:record Resource#Multipart Operations for Raw Data|Multipart]] REST request
* To upload an image, use the instructions to [[Pages#Example: Submit Data that Includes a File Attachment|Submit data that includes a File attachment]]


|-
|-
| [[Lookup]]
| 1:N [[Lookup]]
|
|
* Applies to a Lookup field in a One-to-Many relationship
* Specify a record ID from the target object.
* Specify a record ID from the target object.
|-
| M:N [[Lookup]]
|
* Applies to a Lookup field in a Many-to-Many relationship
* Specify a comma separated list of record IDs from the target object.


|-
|-
Line 83: Line 96:


|-
|-
| [[Multi Select Picklist]] &  
| [[Multi Select Picklist]]<br>&<br>Multi Select Global Picklist
Multi Select Global Pick List
|
|
* A comma-separated list of picklist values.
* A comma-separated list of picklist values.
Line 91: Line 103:
| Number
| Number
|  
|  
* An integer from -2,147,483,646 to 2,147,483,647.
* Specify a value in [[Database Format]], with no separators other than the decimal point.
* Possible values range -2,147,483,646 to 2,147,483,647 (-2147483646 to 2147483647).


|-
|-
| Number with decimals
| Number with decimals
|  
|  
* A number with a decimal point (and no other separators). The number of decimal places is specified in the field definition.  
* Specify a value in [[Database Format]], with no separators other than the decimal point.
* The number of decimal places is specified in the field definition.  


|-
|-
| Percentage
| Percentage
|  
|  
* A decimal value in the range 0 to 1. The number of decimal places is specified in the field definition.  
* Specify a value in [[Database Format]], with no percent sign and no separators other than the decimal point.
* The value must be in the range 0 to 1.  
* The number of decimal places is specified in the field definition.  


|-
|-
| Phone/Fax
| Phone/Fax
|  
|  
* A string of digits, with or without formatting. (Formatting this supplied is preserved.  For example, "123.456.7890". Digits entered without formatting are displayed in the default format:  
{{:Phone Format}}
:* 7 digits ("1234567") displays as "123-4567".
:* 10 digits "1234567890" displays as "(123) 456-7890".
:* 11 digits ("12345678901") displays 1-234-567-8901
 
:''Note:''<br>If the string is longer than 11 digits, it is displayed as entered.<br>In that case, it's helpful to provide the desired formatting.


|-
|-
Line 117: Line 128:
|
|
*Specify one of the picklist values.
*Specify one of the picklist values.
{{:Common:SpecifyingEnumerationValues}}


|-
|-
Line 123: Line 133:
|
|
* Specify one of the radio button values.
* Specify one of the radio button values.
{{:Common:SpecifyingEnumerationValues}}


|-
|-
| Rich Text Area
| Rich Text Area
|
|
*A string containing text and a limited number of HTML tags:
* A string containing text and HTML tags
*: '''bold''', ''italics'', numbered lists, bullet lists, image tags
* Linebreaks can be encoded using <tt>\n</tt> (newline) to make the code readable
* <tt><nowiki><wbr></nowiki></tt> and <tt><nowiki></wbr></nowiki></tt> tags are not supported, as they are problematic when switching between edit and display modes. (To prevent issues, those tags are removed before the content is displayed.)


|-
|-
Line 135: Line 145:
|
|
* A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt>
* A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt>
* Linebreaks can be encoded using <tt>\n</tt> (newline)


|-
|-
Line 144: Line 155:
|  
|  
* A time. For example, "6:50 PM".
* A time. For example, "6:50 PM".
* The field definition determines how the value is stored.
* The field definition and user's [[Locale Settings]] determine how to format the value.


|-
|-

Latest revision as of 01:35, 19 November 2014

This table shows how to format input data for the various Field Display Types in platform objects when using the Java API.

Field Display Types Description
Auto Number

n/a (read only)

Checkbox
  • Specify 1 for Yes/True, 0 for No/False
Currency
  • Specify a value in Database Format, with no currency symbol and no separators other than the decimal point.
Date
  • A date.
  • The field definition and user's Locale Settings determine how to format the value.
Date time
  • A date and time.
  • The field definition and user's Locale Settings determine how to format the value.
Dependent Picklist
  • Specify one of the picklist values.
  • An error is thrown if the list (determined by the parent-field dependency) doesn't include that value.
Email Address
  • A string containing text in email-address format. For example: friend@somewhere.com
External Lookup

n/a

File Field
Formula

n/a

Geolocation

A string containing a latitude and longitude, separated by a comma and a space.
Ex: 37.403930662906106, -121.97971165820213

Global Picklist
  • Specify a picklist value.
Image Field
1:N Lookup
  • Applies to a Lookup field in a One-to-Many relationship
  • Specify a record ID from the target object.
M:N Lookup
  • Applies to a Lookup field in a Many-to-Many relationship
  • Specify a comma separated list of record IDs from the target object.
Multiple Checkboxes
  • A comma-separated list of checkbox values.
Multi Object Lookup
  • The format is objectName:recordID. For example: cases:12345678
Multi Select Picklist
&
Multi Select Global Picklist
  • A comma-separated list of picklist values.
Number
  • Specify a value in Database Format, with no separators other than the decimal point.
  • Possible values range -2,147,483,646 to 2,147,483,647 (-2147483646 to 2147483647).
Number with decimals
  • Specify a value in Database Format, with no separators other than the decimal point.
  • The number of decimal places is specified in the field definition.
Percentage
  • Specify a value in Database Format, with no percent sign and no separators other than the decimal point.
  • The value must be in the range 0 to 1.
  • The number of decimal places is specified in the field definition.
Phone/Fax

If a string of digits is entered without formatting, that is the way it appears when editing, but the numbers are automatically formatted when the field is displayed:

  • 7 digits ("1234567") displays as "123-4567".
  • 10 digits "1234567890" displays as "(123) 456-7890".
  • 11 digits ("12345678901") displays 1-234-567-8901
Note:
If the field has more than 11 digits, they are displayed as entered.
In that case, it's helpful to provide the desired formatting.

Free-format text is displayed exactly as entered. For example:

  • 123.456.7890
  • 1-800-COMPANY
  • +44 7123 456 789
Picklist
  • Specify one of the picklist values.
Radio Buttons
  • Specify one of the radio button values.
Rich Text Area
  • A string containing text and HTML tags
  • Linebreaks can be encoded using \n (newline) to make the code readable
  • <wbr> and </wbr> tags are not supported, as they are problematic when switching between edit and display modes. (To prevent issues, those tags are removed before the content is displayed.)
Text Area
  • A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: / @ . - $ %
  • Linebreaks can be encoded using \n (newline)
Text Field
  • A string containing a single line of text. Text can include alphanumerics (A-Z, a-z, 0-9) and special characters: / @ . - $ %
Time
  • A time. For example, "6:50 PM".
  • The field definition and user's Locale Settings determine how to format the value.
URL