Difference between revisions of "SmartConnect - Appendix: Standard Field Names"

From SmartWiki
Jump to: navigation, search
 
(67 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The following lists the database field names associated with [[Standard Fields]].<br>
+
The following lists the database field names associated with [[Standard Fields]].
−
 
 
−
These are used in JSON API (SmartConnect).<br>
 
−
 
 
−
== Field List Syntax ==
 
  
 +
These are used in JSON API (SmartConnect).
  
 +
==Field List Syntax==
 
{| class="wikitable"
 
{| class="wikitable"
−
|
 
 
|-
 
|-
−
!Field List Syntax
+
!|Field List Syntax
−
!Example
+
!|Example
 
|-
 
|-
−
|Separate values with ";;"  
+
||Separate values with ";;"
−
|sf_Name;;cf_MyFieldName
+
||sf_Name;;cf_MyFieldName;;cf_MyFieldssid
 
|-
 
|-
−
|Prefix Standard fields with "sf_"
+
||Prefix Standard fields with "sf_"
−
|sf_Name
+
||sf_Name
 
|}
 
|}
  
 
==Companies==
 
==Companies==
−
* '''sf_Company ID''': Company id. (0 if new company)
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
−
* '''sf_Parent Company''': Parent company name.
+
|-
−
* '''sf_Parent Company ID''': Parent company id.
+
! width="20%"|API Field Reference
−
* '''sf_Is External''': Flag (1=external, 0=internal)
+
! width="25%"|Field Description
−
* '''sf_Owner ID''': Owner ID of company.
+
! style="text-align: center;" width="15%"|Allow Get/List
−
* '''sf_Owner''': Owner name of company.
+
! style="text-align: center;" width="15%"|Allow Update
−
* '''sf_Primary Contact ID''': Primary contact ID of company. (0 if empty)
+
! width="25%"|Notes External
−
* '''sf_Primary Contact''': Primary contact name of company.
+
|-
−
* '''sf_Name''': Name standard field.
+
||sf_Name
−
* '''sf_Address''': Address standard field.
+
||Name of current company
−
* '''sf_Address 2''': Address2 standard field.
+
| style="text-align: center;"|✓
−
* '''sf_City''': City standard field.
+
| style="text-align: center;"|✓
−
* '''sf_State / Province''': Province standard field.
+
||
−
* '''sf_Zip / Postal Code''': Postal code standard field.
+
|-
−
* '''sf_Country''': ID of country field. (0 if empty)
+
||sf_Phone
−
* '''sf_Phone''': Phone standard field.
+
||
−
* '''sf_Fax''': Fax standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Web Site''': Website standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Category List''': Comma delimited list of category IDs. (Starts and ends with a comma)
+
||
−
* '''sf_Last Updated''': date the record was last updated on SmartSimple
+
|-
−
* '''sf_Created Dated''': date the record was created on SmartSimple
+
||sf_Fax
−
* '''sf_Status ID''': Status ID of the company.
+
||
−
* '''sf_Status''': Status name of the company.
+
| style="text-align: center;"|✓
−
* '''sf_Status Caption''': Status caption of the company.
+
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address 2
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_City
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_State / Province
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Country
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Country ID or Country name as value
 +
|-
 +
||sf_Zip / Postal Code
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Web Site
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Longitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Latitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Primary Contact
 +
||Primary Contact name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Parent Company
 +
||Parent company name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Owner
 +
||Name of User in Owner Standard Field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Company Workflow
 +
||ID of Company workflow standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_User Workflow
 +
||ID of User workflow standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Last Updated
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Status
 +
||Returns Status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Company ID
 +
||Company id. (0 if new company)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||Mandatory field for updating records
 +
|-
 +
||sf_Owner ID
 +
||ID of User in Owner Standard Field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Parent Company ID
 +
||ID of Parent Company
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Primary Contact ID
 +
||Primary Contact ID (0 if empty)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Category ID List
 +
||Comma delimited list of category IDs. (Starts and ends with a comma)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Status ID
 +
||Returns Status ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Is External
 +
||Flag (1=external, 0=internal)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
Mandatory field for adding records
 +
 
 +
For updates, this attribute will follow the attribute of the parent company
 +
 
 +
|-
 +
||sf_Status Caption
 +
||Returns Status Caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
  
 
==Users==
 
==Users==
−
* '''sf_User ID''': User ID (0 if new user)
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
−
* '''sf_Is External''': Flag (1=external, 0=internal)
+
|-
−
* '''sf_Company ID''': ID of user's company. 0 if empty.
+
! width="20%"|API Field Reference
−
* '''sf_Company''': name of user's company.
+
! width="25%"|Field Description
−
* '''sf_Title''': Title standard field.
+
! style="text-align: center;" width="15%"|Allow Get/List
−
* '''sf_Prefix''': Prefix standard field.
+
! style="text-align: center;" width="15%"|Allow Update
−
* '''sf_Suffix''': Suffix standard field.
+
! width="25%"|Notes External
−
* '''sf_First Name''': First name standard field.
+
|-
−
* '''sf_Last Name''': Last name standard field.
+
||sf_First Name
−
* '''sf_Email''': Email standard field.
+
||
−
* '''sf_Address''': Address standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Address 2''': Address 2 standard field.
+
| style="text-align: center;"|✓
−
* '''sf_City''': City standard field.
+
||
−
* '''sf_State / Province''': Province standard field.
+
|-
−
* '''sf_Country''': name of country field. 0 if empty.
+
||sf_Last Name
−
* '''sf_Country ID''': ID of country field. 0 if empty.
+
||
−
* '''sf_Zip / Postal Code''': Postal code standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Phone''': Phone standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Phone Ext''': Phone extension field.
+
||
−
* '''sf_User Role''': Comma delimited list of role IDs. (Starts and ends with a comma)
+
|-
−
* '''sf_Active Type''': 1 ('Administration or Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access')
+
||sf_Email
−
* '''sf_User Type''': 10 ('User'), 30 ('Local User Administrator'), 40 ('Global User Administrator')
+
||
−
* '''sf_Status''': status ID of user
+
| style="text-align: center;"|✓
−
* '''sf_Updated By''': name of user who updated the record.
+
| style="text-align: center;"|✓
−
* '''sf_Last Updated''': date record was last updated.
+
||
−
* '''sf_Created Date''': date record was created.
+
|-
−
* '''sf_Created By''': name of user who created the record.
+
||sf_Title
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Prefix
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Suffix
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Phone
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Phone Ext.
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address 2
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_City
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_State / Province
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Country
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Zip / Postal Code
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Company
 +
||Name of user's company
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||When updating, use Company ID or Company name as value
 +
|-
 +
||sf_Middle Name
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Longitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Latitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_User Role
 +
||Comma delimited list of role IDs. (Starts and ends with a comma)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||sf_User Role and sf_Role ID List are interchangable.
 +
|-
 +
||sf_Access Type
 +
||
 +
1 ('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')
 +
 
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using ID as value
 +
|-
 +
||sf_User Type
 +
||10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using ID as value
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Last Updated
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Status
 +
||Returns Status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_User ID
 +
||User ID (0 if new user)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||Mandatory field for updating records
 +
|-
 +
||sf_Company ID
 +
||ID of user's company. 0 if empty.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Status ID
 +
||Returns Status ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Role ID List
 +
||Comma delimited list of role IDs. (Starts and ends with a comma)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||sf_User Role and sf_Role ID List are interchangable.
 +
|-
 +
||sf_Is External
 +
||Flag (1=external, 0=internal)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
Mandatory field for adding records
 +
 
 +
For updates, this attribute will follow the attribute of the parent company
 +
 
 +
|-
 +
||sf_Status Caption
 +
||Returns Status Caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
  
 
==Level 1==
 
==Level 1==
−
* '''sf_Level One ID''': Tracking ID of level 1.
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
−
* '''sf_Application ID''': UTA ID.
+
|-
−
* '''sf_Company ID''': Company ID of level 1 company/client field. 0 if empty.
+
! width="20%"|API Field Reference
−
* '''sf_Branch ID''': Company ID of level 1 branch field. 0 if empty.
+
! width="25%"|Field Description
−
* '''sf_Person ID''': User ID of level 1 people field. 0 if empty.
+
! style="text-align: center;" width="15%"|Allow Get/List
−
* '''sf_Person''': name of User for level 1 people field.  
+
! style="text-align: center;" width="15%"|Allow Update
−
* '''sf_Type ID''': ID of level 1 template.
+
! width="25%"|Notes External
−
* '''sf_Application Template Type''': Level 1 template type name.
+
|-
−
* '''sf_Application Name''': Name standard field.
+
||sf_Application Type
−
* '''sf_Description''': Description standard field.
+
||Returns level 1 template name
−
* '''sf_Requirement''': Requirement standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Status ID''': Status ID of level 1 status. 0 if empty.
+
| style="text-align: center;"|✓
−
* '''sf_Status''': Name of level 1 status.
+
||Update using Type ID as value
−
* '''sf_Revenue''': Revenue standard field.
+
|-
−
* '''sf_Start Date''': Start date standard field.
+
||sf_Application Name
−
* '''sf_End Date''': End date standard field.
+
||Returns value of Name standard field
−
* '''sf_Close Date''': Close date standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Probability''': Probability standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Owner ID''': ID of level 1 owner.
+
||
−
* '''sf_Owner''': Name of level 1 owner.
+
|-
−
* '''sf_Modified By''': Name of user who modified the record.
+
||sf_Customer
−
* '''sf_Modified Date''': Date the record was modified.
+
||Name of company on Client standard field
−
* '''sf_Created By''': Name of user who created the record.
+
| style="text-align: center;"|✓
−
* '''sf_Created Date''': Date the record was created.
+
| style="text-align: center;"|✓
 +
||Update using Company ID as value
 +
|-
 +
||sf_Person
 +
||Name of contact attached to Person standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using User ID as value
 +
|-
 +
||sf_Status
 +
||Returns Status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Revenue
 +
||Revenue standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Currency
 +
||Currency standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Close Date
 +
||Close Date standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Modified Date
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Modified By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Probability
 +
||Probability standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Description
 +
||Returns value from Description standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Requirement
 +
||Requirement standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Owner
 +
||Returns name of level 1 owner standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Owner ID as value
 +
|-
 +
||sf_Branch
 +
||Returns company name on Branch standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Branch ID as value
 +
|-
 +
||sf_End Date
 +
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Start Date
 +
||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Archived
 +
||Flag (1=Archived, 0=Not Archived)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Level One ID
 +
||Returns unique Level 1 tracking ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
Mandatory field for updating records
 +
 
 +
Use "recordid" in place of "sf_Level One ID" in updating records
 +
 
 +
|-
 +
||sf_Company ID
 +
||Company ID of level 1 company/client field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Person ID
 +
||User ID of level 1 people field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Branch ID
 +
||Company ID of level 1 branch field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Type ID
 +
||ID of level 1 template
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records<br /> Update using Type ID as value
 +
|-
 +
||sf_Status ID
 +
||Status ID of level 1 status. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records<br /> Update using Status ID as value
 +
|-
 +
||sf_Owner ID
 +
||ID of level 1 owner.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Application ID
 +
||Returns UTA ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Status Caption
 +
||Returns Status caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type Caption
 +
||Returns level 1 template caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
  
 
==Level 2==
 
==Level 2==
−
* '''sf_Level Two ID''': Activity ID of level 2.
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
−
* '''sf_Application ID''': UTA ID.
+
|-
−
* '''sf_Description''': Description standard field.
+
! width="20%"|API Field Reference
−
* '''sf_Subject''': Subject standard field.
+
! width="25%"|Field Description
−
* '''sf_Type ID''': ID of level 2/3 type.
+
! style="text-align: center;" width="15%"|Allow Get/List
−
* '''sf_Activity Type''': Level 2 type name.
+
! style="text-align: center;" width="15%"|Allow Update
−
* '''sf_Parent ID''': Parent object ID.
+
! width="25%"|External Notes
−
* '''sf_Assign Person''': Comma delimited list of user IDs in assigned standard field.
+
|-
−
* '''sf_Contact Person''': Comma delimited list of user IDs in contact standard field.
+
||sf_Activity Type
−
* '''sf_Location''': Location standard field.
+
||Returns level 2 type name
−
* '''sf_Start Date''': Start date standard field.
+
| style="text-align: center;"|✓
−
* '''sf_End Date''': End date standard field.
+
| style="text-align: center;"|✓
−
* '''sf_Duration''': Duration standard field.
+
||Update using Type ID as value
−
* '''sf_Amount''': Amount standard field.
+
|-
−
* '''sf_Status ID''': Status ID of status. 0 if empty.
+
||sf_Subject
−
* '''sf_Status''': Status name.
+
||Returns level 2 subject
−
* '''sf_Owner ID''': User ID of owner. 0 if empty.
+
| style="text-align: center;"|✓
−
* '''sf_Owner''': Name of owner.
+
| style="text-align: center;"|✓
−
* '''sf_Updated By''': Name of user who updated the record.
+
||
−
* '''sf_Last Modified''': Date the record was modified.
+
|-
−
* '''sf_Created By''': Name of user who created the record.
+
||sf_Status
−
* '''sf_Created Date''': Date the record was created.
+
||Returns Status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Location
 +
||Location standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Duration
 +
||Duration standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Owner
 +
||Returns name of level 2 owner standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Owner ID as value
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Last Modified
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Start Date
 +
||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_End Date
 +
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Whole Day Event
 +
||Flag (Yes, No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Reminder Sent
 +
||Flag (1=Yes 0=No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Follow-up Sent
 +
||Flag (1=Yes 0=No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Reminder Type
 +
||Returns ID of reminder type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Follow-up Type
 +
||Returns Id of follow-up type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Assign Person
 +
||Comma delimited list of user IDs in assigned standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Contact Person
 +
||Comma delimited list of user IDs in contact standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Description
 +
||Returns value from Description standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Amount
 +
||Returns value from Amount standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Parent Name
 +
||Returns Name standard field from parent level 1
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Longitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Latitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Level Two ID
 +
||Returns unique level 2 ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
Mandatory field for updating records
 +
 
 +
Use "recordid" in place of "sf_Level Two ID" in updating records
 +
 
 +
|-
 +
||sf_Parent ID
 +
||Returns level 1 ID from parent record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L2 records
 +
|-
 +
||sf_Type ID
 +
||ID of level 2 template
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Status ID
 +
||Status ID of level 1 status. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Owner ID
 +
||ID of level 1 owner.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Application ID
 +
||Returns UTA ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Status Caption
 +
||Returns Status caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type Caption
 +
||Returns level 2 type caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
  
 
==Level 3==
 
==Level 3==
−
See Level 2.
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||sf_Activity Type
 +
||Returns level 3 type name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Type ID as value
 +
|-
 +
||sf_Subject
 +
||Returns level 3 subject
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Status
 +
||Returns Status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Status ID as value
 +
|-
 +
||sf_Location
 +
||Location standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Duration
 +
||Duration standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Owner
 +
||Returns name of level 3 owner standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Owner ID as value
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Last Modified
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Start Date
 +
||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_End Date
 +
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Whole Day Event
 +
||Flag (Yes, No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Reminder Sent
 +
||Flag (1=Yes 0=No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Follow-up Sent
 +
||Flag (1=Yes 0=No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Reminder Type
 +
||Returns ID of reminder type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Follow-up Type
 +
||Returns Id of follow-up type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Parent Subject
 +
||Returns Subject field from parent level 2
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Associated Parent
 +
||Displays level 2 ID from soft-linked UTA
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Assign Person
 +
||Comma delimited list of user IDs in assigned standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Contact Person
 +
||Comma delimited list of user IDs in contact standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Description
 +
||Returns value from Description standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Amount
 +
||Returns value from Amount standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Longitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Latitude
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Level Three ID
 +
||Returns unique level 3 ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
Mandatory field for updating records
  
 +
Use "recordid" in place of "sf_Level Three ID" in updating records
  
−
==See Also==
+
|-
−
[[JSON API (SmartConnect)]] <br>
+
||sf_Parent ID
−
[[JSON API (SmartConnect) Prerequisite]]<br>
+
||Returns level 2 ID from parent record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L3 records
 +
|-
 +
||sf_Type ID
 +
||ID of level 3 template
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Status ID
 +
||Status ID of level 1 status. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Owner ID
 +
||ID of level 1 owner.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Application ID
 +
||Returns UTA ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Status Caption
 +
||Returns Status caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type Caption
 +
||Returns level 3 type caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
 +
 
 +
==Multiple Address==
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||sf_Address ID
 +
||Unique id in Multiple Address table
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||Mandatory field for updating records
 +
|-
 +
||sf_Object ID
 +
||Object ID of parent record. Could be companyid, contactid.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Type ID
 +
||Address type ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Type
 +
||Address Type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Address 2
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_City
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_State / Province
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Zip / Postal Code
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Country
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Last Modified
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Primary Address
 +
||Flag (1=Yes, 0=No)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
 +
 
 +
==Associations==
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||objectid
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|}
 +
 
 +
==Transactions==
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||sf_Start Date
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_End Date
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Description
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Subject
 +
||
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Status
 +
||Returns transaction status name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Modified Date
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Updated By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type
 +
||Transaction type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|-
 +
||sf_Transaction ID
 +
||Unique ID for the transaction record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||Mandatory field for updating records
 +
|-
 +
||sf_Object ID
 +
||Parent object id for the transaction
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Mandatory field for adding records
 +
|}
 +
 
 +
==Notes==
 +
Notes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect.
 +
 
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||sf_Note ID
 +
||Unique ID for the Note record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type
 +
||Note Type
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Type ID
 +
||Type ID
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Content
 +
||Contents of the note
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||sf_Object ID
 +
||Parent object id for the note
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|}
 +
 
 +
==System Variables==
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||sf_ID
 +
||System variable record ID.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||Mandatory field for updating records
 +
|-
 +
||sf_Name
 +
||Variable Name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Value
 +
||Value of the variable
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|-
 +
||sf_Description
 +
||Variable Description
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||
 +
|}
  
 +
==Consumer/Provider==
 +
{| class="wikitable" width="85%" cellpadding="5px" align="center"
 +
|-
 +
! width="20%"|API Field Reference
 +
! width="25%"|Field Description
 +
! style="text-align: center;" width="15%"|Allow Get/List
 +
! style="text-align: center;" width="15%"|Allow Update
 +
! width="25%"|External Notes
 +
|-
 +
||providerappid
 +
||[[Determining_the_applicationid|Application ID]] of the provider UTA
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||consumerappid
 +
||[[Determining_the_applicationid|Application ID]] of the consumer UTA
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||providerid
 +
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the provider UTA L1/L2
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||consumerid
 +
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the consumer UTA L1/L2
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 +
||
 +
|-
 +
||roleid
 +
||Connection roleid between consumer/provider
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Updatable
 +
||
 +
|-
 +
||rolename
 +
||Connection rolename between consumer/provider
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Updatable
 +
||
 +
|-
 +
||associationid
 +
||Unique identifier for the consumer/provider relationship table
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"| 
 +
||
 +
||
 +
|}
  
 +
==See Also==
 +
[[SmartConnect_-_RESTful_API|SmartConnect - RESTful API]]
  
  
−
[[Category:API]][[Category:Integration]]
+
[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]

Latest revision as of 11:48, 25 September 2020

The following lists the database field names associated with Standard Fields.

These are used in JSON API (SmartConnect).

Field List Syntax

Field List Syntax Example
Separate values with ";;" sf_Name;;cf_MyFieldName;;cf_MyFieldssid
Prefix Standard fields with "sf_" sf_Name

Companies

API Field Reference Field Description Allow Get/List Allow Update Notes External
sf_Name Name of current company ✓ ✓
sf_Phone ✓ ✓
sf_Fax ✓ ✓
sf_Address ✓ ✓
sf_Address 2 ✓ ✓
sf_City ✓ ✓
sf_State / Province ✓ ✓
sf_Country ✓ ✓ Update using Country ID or Country name as value
sf_Zip / Postal Code ✓ ✓
sf_Web Site ✓ ✓
sf_Longitude ✓ ✓
sf_Latitude ✓ ✓
sf_Primary Contact Primary Contact name ✓ Not Updatable
sf_Parent Company Parent company name ✓ Not Updatable
sf_Owner Name of User in Owner Standard Field ✓ Not Updatable
sf_Company Workflow ID of Company workflow standard field ✓ ✓
sf_User Workflow ID of User workflow standard field ✓ ✓
sf_Updated By Name of user that last updated the record ✓ Not Updatable
sf_Last Updated Date record was last updated ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Status Returns Status name ✓ ✓ Update using Status ID as value
sf_Company ID Company id. (0 if new company) ✓ Not Updatable Mandatory field for updating records
sf_Owner ID ID of User in Owner Standard Field ✓ ✓
sf_Parent Company ID ID of Parent Company ✓ ✓ Mandatory field for adding records
sf_Primary Contact ID Primary Contact ID (0 if empty) ✓ ✓
sf_Category ID List Comma delimited list of category IDs. (Starts and ends with a comma) ✓ ✓
sf_Status ID Returns Status ID ✓ ✓ Update using Status ID as value
sf_Is External Flag (1=external, 0=internal) ✓ Not Updatable

Mandatory field for adding records

For updates, this attribute will follow the attribute of the parent company

sf_Status Caption Returns Status Caption ✓ Not Updatable

Users

API Field Reference Field Description Allow Get/List Allow Update Notes External
sf_First Name ✓ ✓
sf_Last Name ✓ ✓
sf_Email ✓ ✓
sf_Title ✓ ✓
sf_Prefix ✓ ✓
sf_Suffix ✓ ✓
sf_Phone ✓ ✓
sf_Phone Ext. ✓ ✓
sf_Address ✓ ✓
sf_Address 2 ✓ ✓
sf_City ✓ ✓
sf_State / Province ✓ ✓
sf_Country ✓ ✓
sf_Zip / Postal Code ✓ ✓
sf_Company Name of user's company ✓ ✓ When updating, use Company ID or Company name as value
sf_Middle Name ✓ ✓
sf_Longitude ✓ ✓
sf_Latitude ✓ ✓
sf_User Role Comma delimited list of role IDs. (Starts and ends with a comma) ✓ ✓ sf_User Role and sf_Role ID List are interchangable.
sf_Access Type

1 ('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')

✓ ✓ Update using ID as value
sf_User Type 10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’) ✓ ✓ Update using ID as value
sf_Updated By Name of user that last updated the record ✓ Not Updatable
sf_Last Updated Date record was last updated ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Status Returns Status name ✓ ✓ Update using Status ID as value
sf_User ID User ID (0 if new user) ✓ Not Updatable Mandatory field for updating records
sf_Company ID ID of user's company. 0 if empty. ✓ ✓ Mandatory field for adding records
sf_Status ID Returns Status ID ✓ ✓ Update using Status ID as value
sf_Role ID List Comma delimited list of role IDs. (Starts and ends with a comma) ✓ ✓ sf_User Role and sf_Role ID List are interchangable.
sf_Is External Flag (1=external, 0=internal) ✓ Not Updatable

Mandatory field for adding records

For updates, this attribute will follow the attribute of the parent company

sf_Status Caption Returns Status Caption ✓ Not Updatable

Level 1

API Field Reference Field Description Allow Get/List Allow Update Notes External
sf_Application Type Returns level 1 template name ✓ ✓ Update using Type ID as value
sf_Application Name Returns value of Name standard field ✓ ✓
sf_Customer Name of company on Client standard field ✓ ✓ Update using Company ID as value
sf_Person Name of contact attached to Person standard field ✓ ✓ Update using User ID as value
sf_Status Returns Status name ✓ ✓ Update using Status ID as value
sf_Revenue Revenue standard field ✓ ✓
sf_Currency Currency standard field ✓ ✓
sf_Close Date Close Date standard field ✓ ✓
sf_Modified Date Date record was last updated ✓ Not Updatable
sf_Modified By Name of user that last updated the record ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Probability Probability standard field ✓ ✓
sf_Description Returns value from Description standard field ✓ ✓
sf_Requirement Requirement standard field ✓ ✓
sf_Owner Returns name of level 1 owner standard field ✓ ✓ Update using Owner ID as value
sf_Branch Returns company name on Branch standard field ✓ ✓ Update using Branch ID as value
sf_End Date Returns End Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_Start Date Returns Start Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_Archived Flag (1=Archived, 0=Not Archived) ✓ ✓
sf_Level One ID Returns unique Level 1 tracking ID ✓ Not Updatable

Mandatory field for updating records

Use "recordid" in place of "sf_Level One ID" in updating records

sf_Company ID Company ID of level 1 company/client field. 0 if empty ✓ ✓
sf_Person ID User ID of level 1 people field. 0 if empty ✓ ✓
sf_Branch ID Company ID of level 1 branch field. 0 if empty ✓ ✓
sf_Type ID ID of level 1 template ✓ ✓ Mandatory field for adding records
Update using Type ID as value
sf_Status ID Status ID of level 1 status. 0 if empty ✓ ✓ Mandatory field for adding records
Update using Status ID as value
sf_Owner ID ID of level 1 owner. ✓ ✓
sf_Application ID Returns UTA ID ✓ Not Updatable
sf_Status Caption Returns Status caption ✓ Not Updatable
sf_Type Caption Returns level 1 template caption ✓ Not Updatable

Level 2

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_Activity Type Returns level 2 type name ✓ ✓ Update using Type ID as value
sf_Subject Returns level 2 subject ✓ ✓
sf_Status Returns Status name ✓ ✓ Update using Status ID as value
sf_Location Location standard field ✓ ✓
sf_Duration Duration standard field ✓ ✓
sf_Owner Returns name of level 2 owner standard field ✓ ✓ Update using Owner ID as value
sf_Updated By Name of user that last updated the record ✓ Not Updatable
sf_Last Modified Date record was last updated ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Start Date Returns Start Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_End Date Returns End Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_Whole Day Event Flag (Yes, No) ✓ ✓
sf_Reminder Sent Flag (1=Yes 0=No) ✓ ✓
sf_Follow-up Sent Flag (1=Yes 0=No) ✓ ✓
sf_Reminder Type Returns ID of reminder type ✓ ✓
sf_Follow-up Type Returns Id of follow-up type ✓ ✓
sf_Assign Person Comma delimited list of user IDs in assigned standard field ✓ ✓
sf_Contact Person Comma delimited list of user IDs in contact standard field ✓ ✓
sf_Description Returns value from Description standard field ✓ ✓
sf_Amount Returns value from Amount standard field ✓ ✓
sf_Parent Name Returns Name standard field from parent level 1 ✓ ✓
sf_Longitude ✓ Not Updatable
sf_Latitude ✓ Not Updatable
sf_Level Two ID Returns unique level 2 ID ✓ Not Updatable

Mandatory field for updating records

Use "recordid" in place of "sf_Level Two ID" in updating records

sf_Parent ID Returns level 1 ID from parent record ✓ ✓ Mandatory field for adding records

Use "objectid" in place of "sf_Parent ID" for new L2 records
sf_Type ID ID of level 2 template ✓ ✓ Mandatory field for adding records
sf_Status ID Status ID of level 1 status. 0 if empty ✓ ✓ Mandatory field for adding records
sf_Owner ID ID of level 1 owner. ✓ ✓
sf_Application ID Returns UTA ID ✓ Not Updatable
sf_Status Caption Returns Status caption ✓ Not Updatable
sf_Type Caption Returns level 2 type caption ✓ Not Updatable

Level 3

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_Activity Type Returns level 3 type name ✓ ✓ Update using Type ID as value
sf_Subject Returns level 3 subject ✓ ✓
sf_Status Returns Status name ✓ ✓ Update using Status ID as value
sf_Location Location standard field ✓ ✓
sf_Duration Duration standard field ✓ ✓
sf_Owner Returns name of level 3 owner standard field ✓ ✓ Update using Owner ID as value
sf_Updated By Name of user that last updated the record ✓ Not Updatable
sf_Last Modified Date record was last updated ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Start Date Returns Start Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_End Date Returns End Date and Time in YYYY-MM-DD HH:MM:SS ✓ ✓
sf_Whole Day Event Flag (Yes, No) ✓ ✓
sf_Reminder Sent Flag (1=Yes 0=No) ✓ ✓
sf_Follow-up Sent Flag (1=Yes 0=No) ✓ ✓
sf_Reminder Type Returns ID of reminder type ✓ ✓
sf_Follow-up Type Returns Id of follow-up type ✓ ✓
sf_Parent Subject Returns Subject field from parent level 2 ✓ ✓
sf_Associated Parent Displays level 2 ID from soft-linked UTA ✓ ✓
sf_Assign Person Comma delimited list of user IDs in assigned standard field ✓ ✓
sf_Contact Person Comma delimited list of user IDs in contact standard field ✓ ✓
sf_Description Returns value from Description standard field ✓ ✓
sf_Amount Returns value from Amount standard field ✓ ✓
sf_Longitude ✓ Not Updatable
sf_Latitude ✓ Not Updatable
sf_Level Three ID Returns unique level 3 ID ✓ Not Updatable

Mandatory field for updating records

Use "recordid" in place of "sf_Level Three ID" in updating records

sf_Parent ID Returns level 2 ID from parent record ✓ ✓ Mandatory field for adding records

Use "objectid" in place of "sf_Parent ID" for new L3 records
sf_Type ID ID of level 3 template ✓ ✓ Mandatory field for adding records
sf_Status ID Status ID of level 1 status. 0 if empty ✓ ✓ Mandatory field for adding records
sf_Owner ID ID of level 1 owner. ✓ ✓
sf_Application ID Returns UTA ID ✓ Not Updatable
sf_Status Caption Returns Status caption ✓ Not Updatable
sf_Type Caption Returns level 3 type caption ✓ Not Updatable

Multiple Address

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_Address ID Unique id in Multiple Address table ✓ Not Updatable Mandatory field for updating records
sf_Object ID Object ID of parent record. Could be companyid, contactid. ✓ ✓ Mandatory field for adding records
sf_Type ID Address type ID ✓ ✓ Mandatory field for adding records
sf_Type Address Type ✓ ✓
sf_Address ✓ ✓
sf_Address 2 ✓ ✓
sf_City ✓ ✓
sf_State / Province ✓ ✓
sf_Zip / Postal Code ✓ ✓
sf_Country ✓ ✓
sf_Last Modified Date record was last updated ✓ Not Updatable
sf_Primary Address Flag (1=Yes, 0=No) ✓ ✓ Mandatory field for adding records
sf_Updated By Name of user that last updated the record ✓ Not Updatable

Associations

API Field Reference Field Description Allow Get/List Allow Update External Notes
objectid ✓ ✓

Transactions

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_Start Date ✓ ✓
sf_End Date ✓ ✓
sf_Description ✓ ✓
sf_Subject ✓ ✓
sf_Status Returns transaction status name ✓ ✓
sf_Modified Date Date record was last updated ✓ Not Updatable
sf_Updated By Name of user that last updated the record ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Type Transaction type ✓ ✓ Mandatory field for adding records
sf_Transaction ID Unique ID for the transaction record ✓ Not Updatable Mandatory field for updating records
sf_Object ID Parent object id for the transaction ✓ ✓ Mandatory field for adding records

Notes

Notes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect.

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_Note ID Unique ID for the Note record ✓ Not Updatable
sf_Type Note Type ✓ Not Updatable
sf_Type ID Type ID ✓ Not Updatable
sf_Content Contents of the note ✓ Not Updatable
sf_Created By Name of user that created  the record ✓ Not Updatable
sf_Created Date Date the record was created ✓ Not Updatable
sf_Object ID Parent object id for the note ✓ Not Updatable

System Variables

API Field Reference Field Description Allow Get/List Allow Update External Notes
sf_ID System variable record ID. ✓ Not Updatable Mandatory field for updating records
sf_Name Variable Name ✓ ✓
sf_Value Value of the variable ✓ ✓
sf_Description Variable Description ✓ ✓

Consumer/Provider

API Field Reference Field Description Allow Get/List Allow Update External Notes
providerappid Application ID of the provider UTA ✓ Not Updatable
consumerappid Application ID of the consumer UTA ✓ Not Updatable
providerid Opportunity ID or Event ID of the provider UTA L1/L2 ✓ Not Updatable
consumerid Opportunity ID or Event ID of the consumer UTA L1/L2 ✓ Not Updatable
roleid Connection roleid between consumer/provider ✓ Updatable
rolename Connection rolename between consumer/provider ✓ Updatable
associationid Unique identifier for the consumer/provider relationship table ✓  

See Also

SmartConnect - RESTful API

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SmartConnect_-_Appendix:_Standard_Field_Names&oldid=38022’