SmartConnect - Appendix: Standard Field Names

From SmartWiki
Jump to: navigation, search

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 Country ID or Country 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