Difference between revisions of "REST API:Field Type Reference"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
(32 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
This table shows how to format data for | This table shows how to format input data for the various [[Field Display Types]] in platform objects when using the [[REST API]]. | ||
{| border="1" cellpadding="5" cellspacing="0" | {| border="1" cellpadding="5" cellspacing="0" | ||
Line 8: | Line 8: | ||
| Auto Number | | Auto Number | ||
| | | | ||
n/a | n/a (read only) | ||
|- | |- | ||
Line 18: | Line 18: | ||
| Currency | | Currency | ||
| | | | ||
Specify a | * Specify a value in [[Database Format]], with no currency symbol and no separators other than the decimal point. | ||
|- | |- | ||
| [[Date Format|Date]] | | [[Date Format|Date]] | ||
| | | | ||
A date. | * A date in [[UTC Format]]. | ||
* The field definition determines how the value is stored. | |||
|- | |- | ||
| [[Date Format|Date time]] | | <span id="Date_time">[[Date Format|Date time]]<span> | ||
| | | | ||
* A date and time in [[UTC Format]]. | |||
* The field definition determines how the value is stored. | |||
|- | |- | ||
| [[Dependent Picklist]] | | [[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 | | Email Address | ||
| | | | ||
A string containing | * 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, | * To upload a file, do a [[REST API:record Resource#Multipart Operations for Raw Data|Multipart]] REST request | ||
|- | |- | ||
Line 55: | 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> | |||
|- | |- | ||
| [[Global Picklist]] | | [[Global Picklist]] | ||
| | | | ||
Specify a picklist value. | * Specify a picklist value. | ||
|- | |- | ||
| <span id="image">Image Field</span> | | <span id="image">Image Field</span> | ||
| | | | ||
To upload an image | * To upload an image, do a [[REST API:record Resource#Multipart Operations for Raw Data|Multipart]] REST request | ||
|- | |- | ||
| [[Lookup]] | | 1:N [[Lookup]] | ||
| | | | ||
Specify a record ID from the target object. | * 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]] | | [[Multiple Checkboxes]] | ||
| | | | ||
A comma-separated list of checkbox values. | * 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> | * The format is <tt>objectName:recordID</tt>. For example: <tt>cases:12345678</tt> | ||
* The JSON format of Multi Object Lookup value is <tt>@type:objectName</tt> and <tt>content:recordID</tt>. | |||
:For example: | |||
:"related_to": { | |||
:"@type": "cases", | |||
:"content": "1513449967" | |||
:} | |||
|- | |- | ||
| [[Multi Select Picklist]] | | [[Multi Select Picklist]]<br>&<br>Multi Select Global Picklist | ||
| | | | ||
A comma-separated list of picklist values. | * A comma-separated list of picklist values. | ||
|- | |- | ||
| Number | | Number | ||
| | | | ||
An integer from -2,147,483,646 to 2,147,483,647. | * An integer from -2,147,483,646 to 2,147,483,647. Must be in [[Database Format]], with no group separators (commas). | ||
|- | |- | ||
| 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. | * A number in [[Database Format]], with a decimal point (and no other separators). 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. | * A decimal value in the range 0 to 1, in [[Database Format]]. The number of decimal places is specified in the field definition. | ||
|- | |- | ||
| Phone/Fax | | Phone/Fax | ||
| | | | ||
{{:Phone Format}} | |||
|- | |- | ||
| [[Picklist]] | | [[Picklist]] | ||
| | | | ||
*Specify one of the picklist values. | * Specify one of the picklist values. | ||
|- | |- | ||
| Radio Buttons | | Radio Buttons | ||
| | | | ||
Specify one of the radio button values. | * Specify one of the radio button values. | ||
|- | |- | ||
| Rich Text Area | | Rich Text Area | ||
| | | | ||
*A string containing text and | * A string containing text and HTML 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.) | |||
|- | |- | ||
| Text Area | | <span id="text_area">Text Area</span> | ||
| | | | ||
* A multi-line string | * A multi-line string containing alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt>. | ||
* Linebreaks can be encoded using <tt>\n</tt> (newline) | |||
|- | |- | ||
| Text Field || | | Text Field || | ||
* A string containing | * A string containing alphanumerics (A-Z, a-z, 0-9) and special characters: <tt> / @ . - $ % </tt> | ||
|- | |- | ||
| [[Date Format|Time]] | | [[Date Format|Time]] | ||
| | | | ||
A time. | * A time in [[UTC Format]]. | ||
* The field definition determines how the value is stored. | |||
|- | |- | ||
| URL | | | URL | ||
| | |||
* A string containing a web address. For example: http://yourCompany.com | |||
|} | |} | ||
<noinclude> | <noinclude> |
Latest revision as of 11:18, 27 October 2016
This table shows how to format input data for the various Field Display Types in platform objects when using the REST API.
Field Display Types | Description |
---|---|
Auto Number |
n/a (read only) |
Checkbox |
|
Currency |
|
Date |
|
Date time |
|
Dependent Picklist |
|
Email Address |
|
External Lookup |
n/a |
File Field |
|
Formula |
n/a |
Geolocation |
A string containing a latitude and longitude, separated by a comma and a space. |
Global Picklist |
|
Image Field |
|
1:N Lookup |
|
M:N Lookup |
|
Multiple Checkboxes |
|
Multi Object Lookup |
|
Multi Select Picklist & Multi Select Global Picklist |
|
Number |
|
Number with decimals |
|
Percentage |
|
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:
Free-format text is displayed exactly as entered. For example:
|
Picklist |
|
Radio Buttons |
|
Rich Text Area |
|
Text Area |
|
Text Field |
|
Time |
|
URL |
|