REST API:Field Type Reference

From AgileApps Support Wiki
Revision as of 21:09, 2 August 2013 by 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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
  • Generates a unique number based on simple format rules and provided with a starting value
  • Auto Number fields default to YYYY-MM-DD-{0000}, where the number between the curly braces {0000} increments automatically.
  • Curly braces {} are required to generate an auto number
  • The YYYY-MM-DD- prefix is optional. It generates values for year, month, and day.
  • Any prefix can be used.
Checkbox
  • A single check box, where the checked value is "Yes/True" and unchecked value is "No/False"
  • To apply a filter to a checkbox, or import a checkbox field, use:
Yes/True = 1 or No/False = 0
  • When specifying a formula for a default value, the formula must resolve to 1, 0, true, or false. (When typing it in directly, enter one of those values with no quotes around it.)
Currency

Displays currency in the format determined by the user's locale.

Custom Control

Custom Controls are Pages that use HTML and JavaScript to extend the functionality of a web page or customize its interface

Date

A date.

Date time

A date and time.

  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
Dependent Picklist
  • A picklist that is dynamic based on values provided in another field.
  • For example, a Picklist for T-Shirt Sizes might include entries for Adult, Teen and Child.
  • The Adult list might include entries for S, M, L, XL, and XXL sizes.
  • A Teens list might include similar entries, while the Child list might include entries for 0 - 6 mos., 6 - 12 mos., 1T, 2T, and 3T.
  • The resulting hierarchy would be:
  • Size
  • Adult
  • Adult Small
  • Adult Medium
etc.
  • Child
  • Child 0 - 6 mos.
  • Child 6 - 12 mos.
  • etc.
  • Teen
  • Teen Small
  • etc.

(Best practice is to include the entire hierarchy "path" in the entry, so that Adult Small is distinguished from Teen Small. If the entries said simply, "Small", a shipping clerk might not be able to tell which size was intended.)

Email Address

A text string of the form {name}@{domain}.{type}. Example: friend@somewhere.com

File Field

Allows a file to be uploaded as part of the record

Formula

If the formula return type is a DateTime or Time, then the time zone conversion options are available:

  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
Global Picklist
  • A Global Picklist is a type of field that contains a list of values, and performs much the same as a Picklist field
  • Global Picklists contain the kind of default values commonly used in all applications
Example: US states, status level, priority, hat size, apparel size, component part numbers, etc.
  • These predefined fields save time and can be used in any object.
  • When adding a Global Picklist field to an object, you select from the set of Global Picklists that has been defined for this application.
Image Field
  • Allows an image file to be uploaded as part of the record.
Lookup
Multiple Checkboxes
  • Multiple checkboxes are displayed and are associated with a single field.
  • For example, choose your favorite movie genres:
Action / Adventure / Animation / Comedy / Drama / Romance / Documentary / Children's / Fantasy / Sport / Thriller / Western
  • Multiple checkboxes can be selected, for example: Comedy, Romance, Western
  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.
  • If the user makes multiple selections, the value is stored as a comma-separated list. So:
    • If you change the order of the values, new values may be stored differently than old ones.
Multi Object Lookup

A two stage-lookup where the user first selects the object to use, and then looks up a record in that object.

Multi Select Picklist

(Multi Select Global Pick List)

  • A picklist containing multiple values from a Global Picklist
  • Multiple values can be selected from the list and associated with a single field
Number

A numeric (integer) field, for which you specify minimum and maximum values. The default minimum is 0. To go lower, specify a negative number, like -20. The maximum value is 999999999 (999,999,999). That number can be varied as well, up to the maximum integer size 2,147,483,647. (The smallest possible negative value is -2,147,483,646.)

Number with decimals

A numeric field, for which you specify the number of decimal digits.

Percentage

A decimal field in the range 0 to 1, for which you specify the number of decimal digits.

Phone/Fax

A string of digits. If digits are entered with spaces and punctuation marks, they are displayed and edited in exactly that form. (For example, "123.456.7890".) If a string of digits is entered without formatting, that is the way it appears when editing, but it is 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.
Picklist
  • A picklist is a type of field that contains a list of values, usually presented in a drop-down list; Examples:
  • Types of things: Animal, Vegetable, Mineral
  • T-Shirt Size: Extra Small, Small, Medium, Large, Extra Large
  • A single value can be selected from the list
  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.
Radio Buttons

A list used to limit user selection to a single, specific value from a supplied list of values.

  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.
Rich Text Area

An HTML-formatted text area

  • HTML formatting can include font styles, such as Bold, Italics, numbered lists and bullets or images (logos or art)
  • Formatting tools are provided

Considerations:

  • <wbr> and </wbr> tags are not supported, as they are problematic when switching between edit and display modes. (To prevent issues, those tags are therefore 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: / @ . - $ %
Text Field
  • A String that 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".

  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
URL String containing a web address. For example: http://yourCompany.com