Difference between revisions of "REST API/Payload Examples"

Latest revision as of 06:39, 16 November 2018

These are payload examples for the REST API field Resource.

In all examples:

The <title> element is the field's display label.
The <tableColumn> element is the field name.
<customVisibilityCriteria> elements, when present, reflect non-default Field Visibility settings.
The isCaseSpecialField element is a read-only attribute. A user cannot the set the value for this attribute. This value is set to True for all standard cases or case-type specific fields like subject, description, status, and priority. In all other cases, it is set to False.

Auto Number Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>AUTO</type>
       <description>...</description>
       <universalProperty>true</universalProperty>
       <startingNumber>0001</startingNumber>
       <autoNumberFormat>YYYY-MM-DD-{0000}</autoNumberFormat>
   </field>

</platform> </syntaxhighlight>

Note: The startingNumber field is editable only during add/POST requests and not during update/PUT requests.

CheckBox Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>BOOLEAN</type>
       <description>...</description>
       <defaultValue>true</defaultValue>
       <universalProperty>false</universalProperty>
   </field>

</platform> </syntaxhighlight>

Currency Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>CURRENCY</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
       <maxFractionalDigits>2</maxFractionalDigits>
       <displayLength>30</displayLength>
   </field>

</platform> </syntaxhighlight>

Date Field

String postXml = "<platform>

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>DATE</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
   </field>

</platform> </syntaxhighlight>

An additional <display> property can also be specified for custom fields in Custom Objects, with the values:

as_entered - Store and display the value as entered.
convert - Convert the value between time zones.

For example:

String postXml = "<platform>

   <field>
       ...
       <display>as_entered</display>
   </field>

</platform> </syntaxhighlight>

Learn more: Date/Time Display Types

DateTime Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>DATETIME</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
   </field>

</platform> </syntaxhighlight>

An additional <display> property can also be specified for custom fields in Custom Objects, with the values:

as_entered - Store and display the value as entered.
convert - Convert the value between time zones.

For example:

String postXml = "<platform>

   <field>
       ...
       <display>as_entered</display>
   </field>

</platform> </syntaxhighlight>

Learn more: Date/Time Display Types

Dependent Picklist Field

   <title>FIELD LABEL</title>
   <tableColumn>FIELD_NAME</tableColumn>
   <type>DEPENDENT_PICK_LIST</type>
   <description>...</description>
   <parentPicklistId>70ab83f90c7c49f4</parentPicklistId>
   <universalProperty>false</universalProperty>
   <enumerationDetails>
       <showFirstValueAsDefault>false</showFirstValueAsDefault>
       <sortFlag>false</sortFlag>
       <enumerationItems>
           <picklistValue>1</picklistValue>
       </enumerationItems>
       <enumerationItems>
           <picklistValue>2</picklistValue>
       </enumerationItems>
       <enumerationItems>
           <picklistValue>3</picklistValue>
       </enumerationItems>
       <enumerationItems>
           <picklistValue>4</picklistValue>
       </enumerationItems>
       <enumerationItems>
           <picklistValue>5</picklistValue>
       </enumerationItems>
   </enumerationDetails>
   </field>

</platform> </syntaxhighlight>

Email Address

   <title>FIELD LABEL</title>
   <tableColumn>FIELD_NAME</tableColumn>
   <type>LEAD_EMAIL</type>
   <description>...</description>
   <isStandard>false</isStandard>
   <universalProperty>true</universalProperty>
   <displayLength>200</displayLength>
   <maxStorageLength>200</maxStorageLength>
   <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>1714555710</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
       <extendedFieldMetaData>Extended data</extendedFieldMetaData>
   </field>

</platform> </syntaxhighlight>

Email Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>LEAD_EMAIL</type>
       <description>...</description>
       <universalProperty>true</universalProperty>
       <maxStorageLength>50</maxStorageLength>
       <displayLength>30</displayLength>
   </field>

</platform> </syntaxhighlight>

File Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>FILE_FIELD</type>
       <description>...</description>
   </field>

</platform> </syntaxhighlight>

Formula Field (date)

Returns a date and no destination field.

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>FORMULA</type>
       <description>...</description>
       <numberPrecision>0</numberPrecision>
       <universalProperty>false</universalProperty>
       <formula>DATE(2010, 12, 1)</formula>
       <formulaReturnType>DATE</formulaReturnType>
       <formulaDestinationField/>
   </field>

</platform> </syntaxhighlight>

An additional <display> property can also be specified for custom fields in Custom Objects, with the values:

as_entered - Store and display the value as entered.
convert - Convert the value between time zones.

For example:

String postXml = "<platform>

   <field>
       ...
       <display>as_entered</display>
   </field>

</platform> </syntaxhighlight>

Learn more: Date/Time Display Types

Formula Field (number)

Returns a number and a Destination

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>FORMULA</type>
       <description>...</description>
       <numberPrecision>2</numberPrecision>
       <formula>wink_currency + wink_currency</formula>
       <formulaReturnType>NUMBER</formulaReturnType>
       <formulaDestinationField>wink_currency</formulaDestinationField>
       <formula>wink_currency + wink_currency</formula>
   </field>

</platform> </syntaxhighlight>

Global Picklist Field

This payload describes an Object field that references a Global Picklist.
To create or modify a Global Picklist, use the REST API:globalPicklist Resource.

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>GLOBAL_PICK_LIST</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
       <enumerationDetails>
           <showFirstValueAsDefault>true</showFirstValueAsDefault>
           <sortFlag>false</sortFlag>
       </enumerationDetails>
       <globalPicklistId>dabda8ae68a74718a01286a676d3efdc</globalPicklistId>
   </field>

</platform> </syntaxhighlight>

Image File Field

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>IMAGE_FIELD</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
   </field>

</platform> </syntaxhighlight>

Lookup Field

Lookup to a System Object

Add a Lookup to a System Object, with some preset filters:

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>LOOKUP</type>
       <description>...</description>
       <universalProperty>false</universalProperty>
       <lookUpObjectId>f5ed02cfbfdd4a4aaf2f2a3673f29741</lookUpObjectId>
       <lookupDisplayType>POPUP</lookupDisplayType>
       <sortBy>date_created</sortBy>
       <sortOrder>asc</sortOrder>
       <lookupPresetFilter>
           <criteria_1_join_operator/>
           <criteria_1_pre_bracket>(</criteria_1_pre_bracket>
           <criteria_1_post_bracket>)</criteria_1_post_bracket>
           <criteria_1_column>auto_number</criteria_1_column>
           <criteria_1_operator>equals</criteria_1_operator>
           <criteria_1_value>11111</criteria_1_value>
           <criteria_2_join_operator>and</criteria_2_join_operator>
           <criteria_2_pre_bracket/>
           <criteria_2_post_bracket>)</criteria_2_post_bracket>
           <criteria_2_column>wink_currency</criteria_2_column>
           <criteria_2_operator>equals</criteria_2_operator>
           <criteria_2_value>1</criteria_2_value>
           <criteria_3_join_operator>and</criteria_3_join_operator>
           <criteria_3_pre_bracket/>
           <criteria_3_post_bracket/>
           <criteria_3_column/>
           <criteria_3_operator>equals</criteria_3_operator>
           <criteria_3_value/>
           <criteria_4_join_operator>and</criteria_4_join_operator>
           <criteria_4_pre_bracket/>
           <criteria_4_post_bracket/>
           <criteria_4_column/>
           <criteria_4_operator>equals</criteria_4_operator>
           <criteria_4_value/>
           <criteria_5_join_operator>and</criteria_5_join_operator>
           <criteria_5_pre_bracket/>
           <criteria_5_post_bracket/>
           <criteria_5_column/>
           <criteria_5_operator>equals</criteria_5_operator>
           <criteria_5_value/>
       </lookupPresetFilter>
       <recordSelectionType>STANDARD_LOOKUP</recordSelectionType>
       <lookupDependentFieldList>
           <fieldId>63a2f09f16a14af999b81858363b34ba</fieldId>
           <baseFieldId>ebc004fdebb64a8888fc07d5a824c63d</baseFieldId>
       </lookupDependentFieldList>
       <lookupDependentFieldList>
           <fieldId>df02eaaab877428093dda87d8d29022d</fieldId>
           <baseFieldId>98e0b1ae0b8143b28cb1356c364e6ad1</baseFieldId>
       </lookupDependentFieldList>
       <postSelectionJS>alert(\"hello\");</postSelectionJS>
       <lookupFields>98e0b1ae0b8143b2,ebc004fd24c63d,...
       </lookupFields>
   </field>

</platform> </syntaxhighlight>

Lookup to a Custom Page

Add a Lookup to a Custom Object:

   <field>
       <title>FIELD LABEL</title>
       <tableColumn>FIELD_NAME</tableColumn>
       <type>LOOKUP</type>
       <description>...</description>
       <universalProperty>true</universalProperty>
       <lookUpObjectId>f0772f53f82d41879a50c5392de83c3f</lookUpObjectId>
       <customPageId>e379c6e9dd694441b3f525fc7e0c0beb</customPageId>
       <recordSelectionType>CUSTOM_PAGE</recordSelectionType>
       <lookupFields/>
       <isMasterDetailRelationship>false</isMasterDetailRelationship>
       <lookupDisplayType>DROP_DOWN</lookupDisplayType>  
       <extendedFieldMetaData>Testing</extendedFieldMetaData>
       <lookupAutoCopyFields>    
           <lookupAutoCopyField>
              <srcFieldColumn>       // Source field Info
                  <tableColumn>a_currency</tableColumn>
              </srcFieldColumn>
              <destFieldColumn>      // Destination field info
                  <tableColumn>b_fmcurrency</tableColumn>
              </destFieldColumn>
           </lookupAutoCopyField>
           <lookupAutoCopyField>
             ...
           </lookupAutoCopyField>
             ...
       <lookupAutoCopyFields>
    </field>

</platform> </syntaxhighlight>

Field Notes

Field	Possible Values	Notes
lookupDisplayType	POPUP DROP_DOWN
sortBy	Internal field name	These tags are used for: Standard Lookups to Custom Objects Standard Lookups to System Objects shown in a DropDown display They are not used for other kinds of lookups (hierarchical, view/report, custom page), or for lookups to System Objects shown in a PopUp display.
sortOrder	asc desc
tableColumn	Internal field name

Note: Internal field names are those returned by the field resource.

Multi Checkbox

   <title>Wink Multi Check Box</title>
   <type>MULTI_CHECK_BOX</type>
   <tableColumn>wink_multi_check_box</tableColumn>
   <universalProperty>false</universalProperty>
   <enumerationDetails>
       <showFirstValueAsDefault>true</showFirstValueAsDefault>
       <sortFlag>true</sortFlag>
       <enumerationItems>
           <picklistLabel>label1</picklistLabel>
           <picklistValue>value1</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>label2</picklistLabel>
           <picklistValue>value2</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>label3</picklistLabel>
           <picklistValue>value3</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>label4</picklistLabel>
           <picklistValue>value4</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>label5</picklistLabel>
           <picklistValue>value5</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
   </enumerationDetails>
   <orientation>HORIZONTAL</orientation>
   <description>...</description>
   <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>1714555710</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <extendedFieldMetaData>Extended Meta data</extendedFieldMetaData>

</field> </platform> </syntaxhighlight>

Multi Object Lookup

An example that has Post Selection JavaScript for the Multi Object Lookup field.

Note: Either object name or object ID can be used in the <lookUpObjectId> element to specify a target object.

   <field>
       <title>Wink lookup 1</title>
       <type>MULTI_OBJECT_LOOKUP</type>
       <tableColumn>molf1</tableColumn>
       <universalProperty>false</universalProperty>
       <multiObjectLookUpDetails>
           <includeAllObjects>false</includeAllObjects>
           <lookUpObjectId>ACCOUNT</lookUpObjectId>
           <lookUpObjectId>CONTACT</lookUpObjectId>
       </multiObjectLookUpDetails>
       <recordSelectionType>STANDARD_LOOKUP</recordSelectionType>
       <postSelectionJS>alert(\"this works\");</postSelectionJS>
       <description>...</description>
   </field>

</platform> </syntaxhighlight>

An example that uses a custom JSP for the lookup:

   <field>
       <title>Wink lookup 1</title>
       <type>MULTI_OBJECT_LOOKUP</type>
       <tableColumn>molf1</tableColumn>
       <universalProperty>false</universalProperty>
       <multiObjectLookUpDetails>
           <lookUpObjectId>ACCOUNT</lookUpObjectId>
           <lookUpObjectId>CONTACT</lookUpObjectId>
       </multiObjectLookUpDetails>
       <recordSelectionType>CUSTOM_PAGE_STR</recordSelectionType>
       <customPageId>e379c6e9dd694441b3f525fc7e0c0beb</customPageId>
       <description>...</description>
   </field>

</platform>

Considerations

includeAllObjects is true for a multi-object lookup field that can target any object in the platform. When true, the lookUpObjectId list contains an entry for every possible object.

</syntaxhighlight>

Number

   <field>
       <title>Wink number field</title>
       <type>NUMBER</type>
       <tableColumn>wink_number</tableColumn>
       <description>...</description>
       <isSignField>false</isSignField>
       <minNumericValue>0</minNumericValue>
       <maxNumericValue>0</maxNumericValue>
   </field>

</platform> </syntaxhighlight>

Number with Decimals

   <field>
       <title>Wink number field</title>
       <type>DOUBLE</type>
       <tableColumn>test_field_decimal</tableColumn>
       <description>...</description>
       <isSignField>false</isSignField>
       <maxFractionalDigits>2</maxFractionalDigits>
       <displayLength>30</displayLength>
   </field>

</platform> </syntaxhighlight>

Picklist

   <title>Wink Picklist</title>
   <type>PICK_LIST</type>
   <tableColumn>wink_picklist</tableColumn>
   <universalProperty>false</universalProperty>
   <enumerationDetails>
       <showFirstValueAsDefault>true</showFirstValueAsDefault>
       <sortFlag>false</sortFlag>
       <enumerationItems>
           <picklistLabel>label1</picklistLabel>
           <picklistValue>value1</picklistValue>
           <itemOrder>1</itemOrder>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>label2</picklistLabel>
           <picklistValue>value2</picklistValue>
           <itemOrder>2</itemOrder>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
   </enumerationDetails>
   <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>1714555710</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
       <description>...</description>
       <extendedFieldMetaData>Extended Meta data</extendedFieldMetaData>
   </field>

</platform> </syntaxhighlight>

Considerations

If the sortFlag is true, then itemOrder elements are not needed, as the elements are sorted alphabetically by label.
If false, then itemOrder determines the order in which the elements are displayed.
If itemOrder is not present, elements are displayed in the order they are defined.

Radio Button

   <title>Wink Radio Button</title>
   <type>RADIO_BUTTON</type>
   <tableColumn>wink_radio_button</tableColumn>
   <universalProperty>true</universalProperty>
   <enumerationDetails>
       <showFirstValueAsDefault>true</showFirstValueAsDefault>
       <sortFlag>true</sortFlag>
       <description>...</description>
       <enumerationItems>
           <picklistLabel>1</picklistLabel>
           <picklistValue>value1</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
           </enumerationItems>
       <enumerationItems>
           <picklistLabel>2</picklistLabel>
           <picklistValue>value2</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
       <enumerationItems>
           <picklistLabel>3</picklistLabel>
           <picklistValue>value3</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
           </enumerationItems>
       <enumerationItems>
           <picklistLabel>4</picklistLabel>
           <picklistValue>value4</picklistValue>
           <textColor>#000000</textColor>
           <textBgColor>#FFFFFF</textBgColor>
       </enumerationItems>
   </enumerationDetails>
   <orientation>VERTICAL</orientation>
   <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>1714555710</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <description>...</description>
   <extendedFieldMetaData>extended data</extendedFieldMetaData>

</field>

</platform> </syntaxhighlight>

Rich Text Area

       <title>Wink Rich Text Area</title>
       <type>RICHTEXT_AREA</type>
       <tableColumn>wink_rich_text_area</tableColumn>
       <universalProperty>true</universalProperty>
       <description>...</description>
       <width>600</width>
       <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
       <extendedFieldMetaData>Rich Text Area</extendedFieldMetaData>
   </field>

</platform> </syntaxhighlight>

Text Area

   <title>Wink Text Area</title>
   <type>TEXT_AREA</type>
   <tableColumn>wink_text_area</tableColumn>
   <universalProperty>true</universalProperty>
   <description>...</description>
   <width>100</width>
   <height>100</height>
   <customFieldVisibility>
       <roleId>1</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>2</roleId>
       <attribute>READ_ONLY</attribute>
   </customFieldVisibility>
   <customFieldVisibility>
       <roleId>3</roleId>
       <attribute>HIDDEN</attribute>
   </customFieldVisibility>
   <extendedFieldMetaData>Text Area</extendedFieldMetaData>

</field> </platform> </syntaxhighlight>

Text Field

   <field>
       <title>Wink Text Field</title>
       <type>TEXT_FIELD</type>
       <tableColumn>winkTextField</tableColumn>
       <universalProperty>false</universalProperty>
       <displayLength>30</displayLength>
       <description>...</description>
       <maxStorageLength>50</maxStorageLength>
       <customFieldVisibilityList>
           <roleId>1215761260</roleId>
           <attribute>READ_ONLY</attribute>
       </customFieldVisibilityList>
       <customFieldVisibilityList>
           <roleId>1</roleId>
           <attribute>READ_ONLY</attribute>
       </customFieldVisibilityList>
       <customFieldVisibilityList>
           <roleId>2</roleId>
           <attribute>READ_ONLY</attribute>
       </customFieldVisibilityList>
       <customFieldVisibilityList>
           <roleId>3</roleId>
           <attribute>READ_ONLY</attribute>
       </customFieldVisibilityList>
   </field>

</platform> </syntaxhighlight>

Search

where to start

Feedback

customize and design

resources

Tools

Personal tools

Difference between revisions of "REST API/Payload Examples"

Latest revision as of 06:39, 16 November 2018

Contents

Auto Number Field

CheckBox Field

Currency Field

Date Field

DateTime Field

Dependent Picklist Field

Email Address

Email Field

File Field

Formula Field (date)

Formula Field (number)

Global Picklist Field

Image File Field

Lookup Field

Lookup to a System Object

Lookup to a Custom Page

Field Notes

Multi Checkbox

Multi Object Lookup

Number

Number with Decimals

Picklist

Radio Button

Rich Text Area

Text Area

Text Field

@@ Line 1: / Line 1: @@
-Payload examples for the use case: ''Add Fields of the specified [[Field Display Types]] to an [[Object]]''.<br>''Learn more:'' [[REST API:field Resource|REST API <tt>field</tt> Resource]]
+<noinclude>
+__TOC__
+These are payload examples for the [[REST API:field Resource|REST API <tt>field</tt> Resource]].
+</noinclude>
+In all examples:
+:* The <tt><nowiki><title></nowiki></tt> element is the field's '''display label'''.
+:* The <tt><nowiki><tableColumn></nowiki></tt> element is the field '''name'''.
+:* <tt><nowiki><customVisibilityCriteria></nowiki></tt> elements, when present, reflect non-default [[Field#Field Visibility|Field Visibility]] settings.
+:* The <tt><nowiki>isCaseSpecialField</nowiki></tt> element is a read-only attribute. A user cannot the set the value for this attribute. This value is set to '''True''' for all standard cases or case-type specific fields like subject, description, status, and priority. In all other cases, it is set to '''False'''.
-In all examples, Method is '''POST'''.
+====Auto Number Field====
-===Auto Number Field===
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>Wink Auto Number</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>AUTO</type>
-         <tableColumn>winkAutoNumber</tableColumn>
+         <description>...</description>
          <universalProperty>true</universalProperty>
-        <description>Added though wink</description>
          <startingNumber>0001</startingNumber>
          <autoNumberFormat>YYYY-MM-DD-{0000}</autoNumberFormat>
@@ Line 17: / Line 23: @@
 </platform>
 </syntaxhighlight>
+{{Note| The startingNumber field is editable only during add/POST requests and not during update/PUT requests.}}
-===CheckBox Field===
+====CheckBox Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>checkbox</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>BOOLEAN</type>
-         <tableColumn>checkbox</tableColumn>
+         <description>...</description>
          <defaultValue>true</defaultValue>
          <universalProperty>false</universalProperty>
-        <description>Added through REST</description>
      </field>
 </platform>
 </syntaxhighlight>
-===Currency Field===
+====Currency Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>wink currency</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>CURRENCY</type>
-         <tableColumn>wink_currency</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
          <maxFractionalDigits>2</maxFractionalDigits>
          <displayLength>30</displayLength>
-        <description>Added through wink</description>
      </field>
-</platform>";
+</platform>
 </syntaxhighlight>
-===Date Field===
+====Date Field====
 :<syntaxhighlight lang="xml" enclose="div">
 String postXml =  "<platform>
      <field>
-         <title>Wink date field</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>DATE</type>
-         <tableColumn>wink_date_field</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
-        <description/>
      </field>
 </platform>
@@ Line 62: / Line 69: @@
 {{:Common:REST Date Time Display Types}}
-===DateTime Field===
+====DateTime Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>wink date time</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>DATETIME</type>
-         <tableColumn>wink_date_time</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
-        <description>Added through wink</description>
      </field>
 </platform>
@@ Line 77: / Line 84: @@
 {{:Common:REST Date Time Display Types}}
-===Dependent Picklist Field===
+====Dependent Picklist Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
-"<field>
+<field>
-     <title>Wink dependent picklist</title>
+     <title>FIELD LABEL</title>
+    <tableColumn>FIELD_NAME</tableColumn>
      <type>DEPENDENT_PICK_LIST</type>
+    <description>...</description>
+    <parentPicklistId>70ab83f90c7c49f4</parentPicklistId>
      <universalProperty>false</universalProperty>
-    <tableColumn>wink_dependent_picklist</tableColumn>
      <enumerationDetails>
          <showFirstValueAsDefault>false</showFirstValueAsDefault>
@@ Line 104: / Line 113: @@
          </enumerationItems>
      </enumerationDetails>
-    <parentPicklistId>70ab83f90c7c49f4</parentPicklistId>
-    <description>Added through wink</description>
      </field>
 </platform>
 </syntaxhighlight>
-===Email Address===
+====Email Address====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
 <field>
-         <title>Wink Email Address</title>
+    <title>FIELD LABEL</title>
-        <type>LEAD_EMAIL</type>
+    <tableColumn>FIELD_NAME</tableColumn>
-        <isStandard>false</isStandard>
+    <type>LEAD_EMAIL</type>
-        <tableColumn>wink_email_address</tableColumn>
+    <description>...</description>
-        <universalProperty>true</universalProperty>
+    <isStandard>false</isStandard>
-        <displayLength>200</displayLength>
+    <universalProperty>true</universalProperty>
-        <description>Email address</description>
+    <displayLength>200</displayLength>
-        <maxStorageLength>200</maxStorageLength>
+    <maxStorageLength>200</maxStorageLength>
-        <customFieldVisibility>
+    <customFieldVisibility>
          <roleId>1</roleId>
          <attribute>READ_ONLY</attribute>
@@ Line 144: / Line 151: @@
 </syntaxhighlight>
-===Email Field===
+====Email Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>Wink Email Address</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>LEAD_EMAIL</type>
-         <tableColumn>wink_email_address</tableColumn>
+         <description>...</description>
          <universalProperty>true</universalProperty>
          <maxStorageLength>50</maxStorageLength>
          <displayLength>30</displayLength>
-        <description>Added through wink</description>
      </field>
 </platform>
 </syntaxhighlight>
-===File Field===
+====File Field====
 :<syntaxhighlight lang="xml" enclose="div">
-String posetXml = "<platform>
+<platform>
      <field>
-         <title>Wink file field</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>FILE_FIELD</type>
-        <tableColumn>wink_file_field</tableColumn>
+         <description>...</description>
-         <description>Added through wink</description>
      </field>
 </platform>
 </syntaxhighlight>
-===Formula Field (date)===
+====Formula Field (date)====
 Returns a date and no destination field.
@@ Line 177: / Line 184: @@
 <platform>
      <field>
-         <title>Wink formula 2</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>FORMULA</type>
-         <tableColumn>wink_formula_2</tableColumn>
+         <description>...</description>
          <numberPrecision>0</numberPrecision>
          <universalProperty>false</universalProperty>
          <formula>DATE(2010, 12, 1)</formula>
          <formulaReturnType>DATE</formulaReturnType>
-        <description>Added through Wink</description>
          <formulaDestinationField/>
      </field>
@@ Line 192: / Line 199: @@
 {{:Common:REST Date Time Display Types}}
-===Formula Field (number)===
+====Formula Field (number)====
 Returns a number and a Destination
@@ Line 198: / Line 205: @@
 <platform>
      <field>
-         <title>Wink formula 1</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>FORMULA</type>
-         <tableColumn>wink_formula_1</tableColumn>
+         <description>...</description>
          <numberPrecision>2</numberPrecision>
          <formula>wink_currency + wink_currency</formula>
          <formulaReturnType>NUMBER</formulaReturnType>
-        <description>Added through wink</description>
          <formulaDestinationField>wink_currency</formulaDestinationField>
          <formula>wink_currency + wink_currency</formula>
@@ Line 211: / Line 218: @@
 </syntaxhighlight>
-===Global Picklist Field===
+====Global Picklist Field====
+This payload describes an Object field that references a [[Global Picklist]].<br>
+To create or modify a Global Picklist, use the [[REST API:globalPicklist Resource]].
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>Wink Global pick</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>GLOBAL_PICK_LIST</type>
-         <tableColumn>wink_global_pick</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
          <enumerationDetails>
@@ Line 224: / Line 234: @@
          </enumerationDetails>
          <globalPicklistId>dabda8ae68a74718a01286a676d3efdc</globalPicklistId>
-        <description>Added through wink</description>
      </field>
 </platform>
 </syntaxhighlight>
-===Image File Field===
+====Image File Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>Wink image field</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>IMAGE_FIELD</type>
-         <tableColumn>wink_image_field</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
-        <description>Added through rest</description>
      </field>
 </platform>
 </syntaxhighlight>
-===Lookup Field===
+====Lookup Field====
-====Lookup to a {{Typenolink}}====
+=====Lookup to a {{Typenolink}}=====
 Add a Lookup to a {{type}}, with some preset filters:
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
      <field>
-         <title>Wink lookup 1</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>LOOKUP</type>
-         <tableColumn>wink_lookup_1</tableColumn>
+         <description>...</description>
          <universalProperty>false</universalProperty>
          <lookUpObjectId>f5ed02cfbfdd4a4aaf2f2a3673f29741</lookUpObjectId>
-         <lookupDisplayType>POPUP</lookupDisplayType> // POPUP or DROP_DOWN
+         <lookupDisplayType>POPUP</lookupDisplayType>
          <sortBy>date_created</sortBy>
-         <sortOrder>asc</sortOrder>                   // asc or desc
+         <sortOrder>asc</sortOrder>
          <lookupPresetFilter>
              <criteria_1_join_operator/>
@@ Line 298: / Line 308: @@
              <baseFieldId>98e0b1ae0b8143b28cb1356c364e6ad1</baseFieldId>
          </lookupDependentFieldList>
-         <postSelectionJS>alert(\"this works\");</postSelectionJS>
+         <postSelectionJS>alert(\"hello\");</postSelectionJS>
-         <lookupFields>
+         <lookupFields>98e0b1ae0b8143b2,ebc004fd24c63d,...
-        ,98e0b1ae0b8143b28cb1356c364e6ad1,ebc004fdebb64a8888fc07d5a824c63d
          </lookupFields>
-        <description>Added through wink</description>
      </field>
 </platform>
 </syntaxhighlight>
-====Lookup to a {{typenolink|}}====
+=====Lookup to a Custom Page=====
 Add a Lookup to a {{type|}}:
@@ Line 313: / Line 321: @@
 <platform>
      <field>
-         <title>Lookup Custom page</title>
+         <title>FIELD LABEL</title>
+        <tableColumn>FIELD_NAME</tableColumn>
          <type>LOOKUP</type>
-         <tableColumn>wink_lookup_custom_page</tableColumn>
+         <description>...</description>
          <universalProperty>true</universalProperty>
          <lookUpObjectId>f0772f53f82d41879a50c5392de83c3f</lookUpObjectId>
@@ Line 321: / Line 330: @@
          <recordSelectionType>CUSTOM_PAGE</recordSelectionType>
          <lookupFields/>
-        <description>Added through Wink<description/>
          <isMasterDetailRelationship>false</isMasterDetailRelationship>
-         <lookupDisplayType>DROP_DOWN</lookupDisplayType>     // POPUP or DROP_DOWN
+         <lookupDisplayType>DROP_DOWN</lookupDisplayType>
-        <sortBy>date_created</sortBy>
-        <sortOrder>desc</sortOrder>                          // asc or desc
          <extendedFieldMetaData>Testing</extendedFieldMetaData>
          <lookupAutoCopyFields>
              <lookupAutoCopyField>
-                <srcFieldColumn>                              // Source field Info
+                <srcFieldColumn>       // Source field Info
-                    <tableColumn>a_currency</tableColumn>     // Source field table column name
+                    <tableColumn>a_currency</tableColumn>
                 </srcFieldColumn>
-                <destFieldColumn>                             // Destination field info
+                <destFieldColumn>      // Destination field info
-                    <tableColumn>b_fmcurrency</tableColumn>   // Destination field table column name
+                    <tableColumn>b_fmcurrency</tableColumn>
                 </destFieldColumn>
              </lookupAutoCopyField>
@@ Line 345: / Line 351: @@
 </syntaxhighlight>
-====Lookup Fields====
+===== Field Notes =====
-:{| border="1" cellpadding="5" cellspacing="0"
+:{| border="1" cellpadding="5" cellspacing="1"
-! Name !! Possible Values
+! Field !! Possible Values !! Notes
 |-
-| lookupDisplayType
+|  valign="top"| lookupDisplayType
 |
 * POPUP
 * DROP_DOWN
+|
+|-
+| valign="top"| sortBy
+| Internal&nbsp;field&nbsp;name
+| rowspan="2" |
+These tags are used for:
+* Standard Lookups to {{type|}}s
+* Standard Lookups to {{type}}s shown in a DropDown display
+They are not used for other kinds of lookups (hierarchical, view/report, custom page), or for lookups to {{type}}s shown in a PopUp display.
 |-
-| sortOrder
+|  valign="top"| sortOrder
-|
+|  valign="top"|
 * asc
 * desc
+|-
+| valign="top"| tableColumn
+| Internal field name
+|
 |}
-===Multi Checkbox===
+{{Note| Internal field names are those returned by the [[REST API:field Resource|field]] resource.}}
+====Multi Checkbox====
 :<syntaxhighlight lang="xml" enclose="div">
@@ Line 406: / Line 428: @@
      </enumerationDetails>
      <orientation>HORIZONTAL</orientation>
-     <description>Multi Check Box</description>
+     <description>...</description>
      <customFieldVisibility>
          <roleId>1</roleId>
@@ Line 427: / Line 449: @@
 </platform>
 </syntaxhighlight>
-===Multi Object Lookup===
+====Multi Object Lookup====
 An example that has [[Post Selection JavaScript]] for the [[Multi Object Lookup]] field.
@@ Line 440: / Line 462: @@
          <universalProperty>false</universalProperty>
          <multiObjectLookUpDetails>
+            <includeAllObjects>false</includeAllObjects>
              <lookUpObjectId>ACCOUNT</lookUpObjectId>
              <lookUpObjectId>CONTACT</lookUpObjectId>
@@ Line 445: / Line 468: @@
          <recordSelectionType>STANDARD_LOOKUP</recordSelectionType>
          <postSelectionJS>alert(\"this works\");</postSelectionJS>
-         <description>Added through wink</description>
+         <description>...</description>
      </field>
 </platform>
@@ Line 464: / Line 487: @@
          <recordSelectionType>CUSTOM_PAGE_STR</recordSelectionType>
          <customPageId>e379c6e9dd694441b3f525fc7e0c0beb</customPageId>
-         <description>Added through wink</description>
+         <description>...</description>
      </field>
 </platform>
+;Considerations:
+:* <tt>includeAllObjects</tt> is true for a multi-object lookup field that can target any object in the platform. When true, the <tt>lookUpObjectId</tt> list contains an entry for every possible object.
 </syntaxhighlight>
-===Number===
+====Number====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
@@ Line 477: / Line 503: @@
          <type>NUMBER</type>
          <tableColumn>wink_number</tableColumn>
-         <description>Added through wink</description>
+         <description>...</description>
          <isSignField>false</isSignField>
          <minNumericValue>0</minNumericValue>
@@ Line 485: / Line 511: @@
 </syntaxhighlight>
-===Number with Decimals===
+====Number with Decimals====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
@@ Line 492: / Line 518: @@
          <type>DOUBLE</type>
          <tableColumn>test_field_decimal</tableColumn>
-         <description>A double-precision float value.</description>
+         <description>...</description>
          <isSignField>false</isSignField>
          <maxFractionalDigits>2</maxFractionalDigits>
@@ Line 500: / Line 526: @@
 </syntaxhighlight>
-===Picklist===
+====Picklist====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
@@ Line 510: / Line 536: @@
      <enumerationDetails>
          <showFirstValueAsDefault>true</showFirstValueAsDefault>
-         <sortFlag>true</sortFlag>
+         <sortFlag>false</sortFlag>
          <enumerationItems>
              <picklistLabel>label1</picklistLabel>
              <picklistValue>value1</picklistValue>
+            <itemOrder>1</itemOrder>
              <textColor>#000000</textColor>
              <textBgColor>#FFFFFF</textBgColor>
-            </enumerationItems>
+        </enumerationItems>
          <enumerationItems>
              <picklistLabel>label2</picklistLabel>
              <picklistValue>value2</picklistValue>
+            <itemOrder>2</itemOrder>
              <textColor>#000000</textColor>
              <textBgColor>#FFFFFF</textBgColor>
-            </enumerationItems>
+        </enumerationItems>
      </enumerationDetails>
      <customFieldVisibility>
@@ Line 540: / Line 568: @@
          <attribute>READ_ONLY</attribute>
      </customFieldVisibility>
-         <description>Pick List</description>
+         <description>...</description>
          <extendedFieldMetaData>Extended Meta data</extendedFieldMetaData>
      </field>
 </platform>
 </syntaxhighlight>
+;Considerations:
+:* If the <tt>sortFlag</tt> is <tt>true</tt>, then <tt>itemOrder</tt> elements are not needed, as the elements are sorted alphabetically by label.
+:* If <tt>false</tt>, then <tt>itemOrder</tt> determines the order in which the elements are displayed.
+:* If <tt>itemOrder</tt> is not present, elements are displayed in the order they are defined.
-===Radio Button===
+====Radio Button====
 :<syntaxhighlight lang="xml" enclose="div">
@@ Line 558: / Line 590: @@
          <showFirstValueAsDefault>true</showFirstValueAsDefault>
          <sortFlag>true</sortFlag>
-         <description>Radio Buttons</description>
+         <description>...</description>
          <enumerationItems>
              <picklistLabel>1</picklistLabel>
@@ Line 601: / Line 633: @@
          <attribute>READ_ONLY</attribute>
      </customFieldVisibility>
-     <description>Adding radio buttons</description>
+     <description>...</description>
      <extendedFieldMetaData>extended data</extendedFieldMetaData>
 </field>
@@ Line 608: / Line 640: @@
 </syntaxhighlight>
-===Rich Text Area===
+====Rich Text Area====
 :<syntaxhighlight lang="xml" enclose="div">
@@ Line 617: / Line 649: @@
          <tableColumn>wink_rich_text_area</tableColumn>
          <universalProperty>true</universalProperty>
-         <description>Adding Rich Text Area</description>
+         <description>...</description>
          <width>600</width>
          <customFieldVisibility>
@@ Line 636: / Line 668: @@
 </syntaxhighlight>
-===Text Area===
+====Text Area====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
@@ Line 644: / Line 676: @@
      <tableColumn>wink_text_area</tableColumn>
      <universalProperty>true</universalProperty>
-     <description>Adding Text Area</description>
+     <description>...</description>
      <width>100</width>
      <height>100</height>
@@ Line 664: / Line 696: @@
 </syntaxhighlight>
-===Text Field===
+====Text Field====
 :<syntaxhighlight lang="xml" enclose="div">
 <platform>
@@ Line 673: / Line 705: @@
          <universalProperty>false</universalProperty>
          <displayLength>30</displayLength>
-         <description>first test through rest</description>
+         <description>...</description>
          <maxStorageLength>50</maxStorageLength>
          <customFieldVisibilityList>