Difference between revisions of "REST API:Field Type Reference"
imported>Aeric (Created page with "This table shows how to format data for each of the Field Display Types in a platform object, when using the REST API. {| border="1" cellpadding="5" cellspacing="0" !Fi...") Β |
imported>Aeric |
||
Line 8: | Line 8: | ||
| Auto Number | | Auto Number | ||
| | | | ||
n/a | |||
|- | |- | ||
| [[Checkbox]] | | [[Checkbox]] | ||
| | | | ||
* | * Specify 1 for Yes/True, 0 for No/False | ||
|- | |- | ||
| Currency | | Currency | ||
| | | | ||
Specify a decimal value, with no currency symbol and no separators other than the decimal point. Β | |||
|- | |- | ||
| [[Custom Control]] | | [[Custom Control]] | ||
| | | | ||
n/a | |||
|- | |- | ||
| [[Date Format|Date]] Β | | [[Date Format|Date]] Β | ||
| | | | ||
A date. | A date. See "Date time", below. | ||
|- | |- | ||
Line 46: | Line 39: | ||
| [[Dependent Picklist]] | | [[Dependent Picklist]] | ||
| | | | ||
n/a | |||
Β | |||
|- | |- | ||
| Email Address Β | | Email Address Β | ||
| Β | | Β | ||
A | A string containing of the form {name}@{domain}.{type}. Example: friend@somewhere.com | ||
|- | |- | ||
| File Field Β | | File Field Β | ||
| Β | | Β | ||
To upload a file, use the [[...]] | |||
|- | |- | ||
| [[Formula Fields|Formula]] | | [[Formula Fields|Formula]] | ||
| | | | ||
n/a | |||
|- | |- | ||
| [[Global Picklist]] | | [[Global Picklist]] | ||
| | | | ||
Specify a picklist value. | |||
|- | |- | ||
| <span id="image">Image Field</span> | | <span id="image">Image Field</span> | ||
| | | | ||
To upload an image file, use the [[...]] | |||
|- | |- | ||
| [[Lookup]] | | [[Lookup]] | ||
| | | | ||
Specify a record ID from the target object. | |||
|- | |- | ||
| [[Multiple Checkboxes]] | | [[Multiple Checkboxes]] | ||
| | | | ||
A comma-separated list of checkbox values. | |||
|- | |- | ||
| [[Multi Object Lookup]] | | [[Multi Object Lookup]] | ||
| | | | ||
The format is <tt>objectName:recordID</tt>. For example: <tt>cases:12345678</tt> | |||
|- | |- | ||
Line 125: | Line 85: | ||
(Multi Select Global Pick List) | (Multi Select Global Pick List) | ||
| | | | ||
A comma-separated list of picklist values. | |||
|- | |- | ||
| Number | | Number | ||
| Β | | Β | ||
An integer from -2,147,483,646 to 2,147,483,647. | |||
|- | |- | ||
| Number with decimals | | Number with decimals | ||
| Β | | Β | ||
A | A number with a decimal point (and no other separators). The number of decimal places is specified in the field definition. Β | ||
|- | |- | ||
| Percentage | | Percentage | ||
| Β | | Β | ||
A decimal | A decimal value 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 | 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: Β | ||
:* 7 digits ("1234567") displays as "123-4567". | :* 7 digits ("1234567") displays as "123-4567". | ||
:* 10 digits "1234567890" displays as "(123) 456-7890". | :* 10 digits "1234567890" displays as "(123) 456-7890". | ||
:* 11 digits ("12345678901") displays 1-234-567-8901 | :* 11 digits ("12345678901") displays 1-234-567-8901 | ||
:''Note:''<br>If the | :''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. Β | ||
|- | |- | ||
| [[Picklist]] | | [[Picklist]] | ||
| | | | ||
* | *Specify one of the picklist values. | ||
{{:Common:SpecifyingEnumerationValues}} | {{:Common:SpecifyingEnumerationValues}} | ||
Line 165: | Line 121: | ||
| Radio Buttons | | Radio Buttons | ||
| | | | ||
Specify one of the radio button values. | |||
{{:Common:SpecifyingEnumerationValues}} | {{:Common:SpecifyingEnumerationValues}} | ||
Line 171: | Line 127: | ||
| Rich Text Area | | Rich Text Area | ||
| | | | ||
*A string containing text and a limited number of HTML tags: | |||
* | *: '''bold''', ''italics'', numbered lists, bullet lists, image tags | ||
|- | |- | ||
| Text Area | | Text Area | ||
| | | | ||
* A multi-line | * A multi-line string that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt> | ||
|- | |- | ||
| Text Field || | | Text Field || | ||
* A | * A string containing a single line of text. Text can include alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt> | ||
|- | |- | ||
Line 193: | Line 146: | ||
|- | |- | ||
| URL || | | URL || A string containing a web address. For example: http://yourCompany.com | ||
|} | |} | ||
<noinclude> | <noinclude> |
Revision as of 21:29, 2 August 2013
This table shows how to format data for each of the Field Display Types in a platform object, when using the REST API.
Field Display Types | Description |
---|---|
Auto Number |
n/a |
Checkbox |
|
Currency |
Specify a decimal value, with no currency symbol and no separators other than the decimal point. |
Custom Control |
n/a |
Date |
A date. See "Date time", below. |
Date time |
A date and time.
|
Dependent Picklist |
n/a |
Email Address |
A string containing of the form {name}@{domain}.{type}. Example: friend@somewhere.com |
File Field |
To upload a file, use the ... |
Formula |
n/a |
Global Picklist |
Specify a picklist value. |
Image Field |
To upload an image file, use the ... |
Lookup |
Specify a record ID 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 Pick List) |
A comma-separated list of picklist values. |
Number |
An integer from -2,147,483,646 to 2,147,483,647. |
Number with decimals |
A number with a decimal point (and no other separators). The number of decimal places is specified in the field definition. |
Percentage |
A decimal value in the range 0 to 1. The number of decimal places is specified in the field definition. |
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:
|
Picklist |
|
Radio Buttons |
Specify one of the radio button values.
|
Rich Text Area |
|
Text Area |
|
Text Field |
|
Time |
A time. For example, "6:50 PM".
|
URL | A string containing a web address. For example: http://yourCompany.com |