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

From SmartWiki
Jump to: navigation, search
(Updating table format for all sections.)
(Level 1)
Line 414: Line 414:
  
 
==Level 1==
 
==Level 1==
{| class="wikitable" cellpadding="5px" align="center"
+
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|- style="font-weight: bold; text-align: center;"
 
| style="border: 1px solid gray;" width="5%"|
 
''' '''
 
 
 
| style="border: 1px solid gray;" width="25%"|
 
'''Standard Field Name'''
 
 
 
| style="border: 1px solid gray;" width="25%"|
 
'''Description'''
 
 
 
| style="border: 1px solid gray;" width="25%"|
 
'''GET Method'''
 
 
 
| style="border: 1px solid gray;" width="20%"|
 
'''UPDATE Method'''
 
 
 
 
|-
 
|-
 +
! 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%"|Notes External
 +
|-
 +
||sf_Application Type
 +
||Returns level 1 template name
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 +
||Update using Type ID as value
 +
|-
 +
||sf_Application Name
 +
||Returns value of Name standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
1
+
|-
 
+
||sf_Customer
||
+
||Name of company on Client standard field
sf_Level One ID
+
| style="text-align: center;"|
 
+
| style="text-align: center;"|✓
||
+
||Update using Company ID as value
Tracking ID of level 1
+
|-
 
+
||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;"|✓
 
||
 
||
'''                  Not Updatable'''
 
 
Mandatory field for updating records
 
 
 
|-
 
|-
 +
||sf_Currency
 +
||Currency standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
2
 
 
||
 
sf_Application ID
 
 
||
 
UTA ID
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
Mandatory field for updating records
 
 
 
|-
 
|-
 +
||sf_Close Date
 +
||Close Date standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
3
 
 
||
 
sf_Company ID
 
 
||
 
Company ID of level 1 company/client field. 0 if empty
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Modified Date
 +
||Date record was last updated
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
4
 
 
||
 
sf_Customer
 
 
||
 
Name of company
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Modified By
 +
||Name of user that last updated the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
5
 
 
||
 
sf_Branch ID
 
 
||
 
Company ID of level 1 branch field. 0 if empty
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Created Date
 +
||Date the record was created
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
6
 
 
||
 
sf_Person ID
 
 
||
 
User ID of level 1 people field. 0 if empty
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Created By
 +
||Name of user that created  the record
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
7
 
 
||
 
Sf_Person
 
 
||
 
Name of Person
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Probability
 +
||Probability standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
8
 
 
||
 
sf_Type ID
 
 
||
 
ID of level 1 template
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
Mandatory field for adding records
 
 
 
|-
 
|-
 +
||sf_Description
 +
||Returns value from Description standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
9
 
 
||
 
sf_Application Type
 
 
||
 
Level 1 template type name
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Requirement
 +
||Requirement standard field
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
10
 
 
||
 
sf_Application Name
 
 
||
 
Name standard field
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
||
+
||sf_Owner
11
+
||Returns name of level 1 owner standard field
 
+
| style="text-align: center;"|✓
||
+
| style="text-align: center;"|✓
sf_Description
+
||Update using Owner ID as value
 
 
||
 
Description standard field
 
 
 
||
 
                             
 
 
 
||
 
                             
 
 
 
 
|-
 
|-
||
+
||sf_Branch
12
+
||Returns company name on Branch standard field
 
+
| style="text-align: center;"|✓
||
+
| style="text-align: center;"|✓
sf_Requirement
+
||Update using Branch ID as value
 
 
||
 
Requirement standard field
 
 
 
||
 
                             
 
 
 
||
 
                             
 
 
 
 
|-
 
|-
 +
||sf_End Date
 +
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
13
 
 
||
 
sf_Status ID
 
 
||
 
Status ID of level 1 status. 0 if empty
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
Mandatory field for adding records
 
 
 
|-
 
|-
 +
||sf_Start Date
 +
||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
14
 
 
||
 
sf_Status
 
 
||
 
Name of level 1 status
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Archived
 +
||Flag (1=Archived, 0=Not Archived)
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
15
 
 
||
 
sf_Revenue
 
 
||
 
Revenue standard field
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
||
+
||sf_Level One ID
16
+
||Returns unique Level 1 tracking ID
 
+
| style="text-align: center;"|
||
+
| style="text-align: center;"|Not Updatable
sf_Start Date
+
||Mandatory field for updating records
 
 
||
 
Start date standard field
 
 
 
||
 
                              ✓
 
 
 
||
 
                              ✓
 
 
 
 
|-
 
|-
 +
||sf_Company ID
 +
||Company ID of level 1 company/client field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
17
 
 
||
 
sf_End Date
 
 
||
 
End date standard field
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Person ID
 +
||User ID of level 1 people field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
18
 
 
||
 
sf_Close Date
 
 
||
 
Close date standard field
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
 +
||sf_Branch ID
 +
||Company ID of level 1 branch field. 0 if empty
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
19
 
 
||
 
sf_Probability
 
 
||
 
Probability standard field
 
 
||
 
                              ✓
 
 
||
 
                              ✓
 
 
 
|-
 
|-
||
+
||sf_Type ID
20
+
||ID of level 1 template
 
+
| style="text-align: center;"|✓
||
+
| style="text-align: center;"|✓
sf_Owner ID
+
||Mandatory field for adding records<br /> Update using Type ID as value
 
 
||
 
ID of level 1 owner.
 
 
 
||
 
                             
 
 
 
||
 
                             
 
 
 
 
|-
 
|-
||
+
||sf_Status ID
21
+
||Status ID of level 1 status. 0 if empty
 
+
| style="text-align: center;"|✓
||
+
| style="text-align: center;"|✓
sf_Owner
+
||Mandatory field for adding records<br /> Update using Status ID as value
 
 
||
 
Name of level 1 owner
 
 
 
||
 
                             
 
 
 
||
 
                             
 
 
 
 
|-
 
|-
 +
||sf_Owner ID
 +
||ID of level 1 owner.
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|✓
 
||
 
||
22
 
 
||
 
sf_Modified By
 
 
||
 
Name of user who modified the record
 
 
||
 
                              ✓
 
 
||
 
'''                  Not Updatable'''
 
 
 
|-
 
|-
||
+
||sf_Application ID
23
+
||Returns UTA ID
 
+
| style="text-align: center;"|✓
||
+
| style="text-align: center;"|Not Updatable
sf_Modified Date
+
||Mandatory field for updating records
 
 
||
 
Date the record was modified
 
 
 
||
 
                             
 
 
 
||
 
'''                  Not Updatable'''
 
 
 
 
|-
 
|-
 +
||sf_Status Caption
 +
||Returns Status caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
24
 
 
||
 
sf_Created By
 
 
||
 
Name of user who created the record
 
 
||
 
                              ✓
 
 
||
 
'''                  Not Updatable'''
 
 
 
|-
 
|-
 +
||sf_Type Caption
 +
||Returns level 1 template caption
 +
| style="text-align: center;"|✓
 +
| style="text-align: center;"|Not Updatable
 
||
 
||
25
 
 
||
 
sf_Created Date
 
 
||
 
Date record was created
 
 
||
 
                              ✓
 
 
||
 
'''                  Not Updatable'''
 
 
 
|}
 
|}
  

Revision as of 12:00, 22 June 2018

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) Mandatory field for adding records
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) Mandatory field for adding records
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
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 Mandatory field for updating records
sf_Status Caption Returns Status caption Not Updatable
sf_Type Caption Returns level 1 template caption Not Updatable

Level 2

 

Standard Field Name

Description

GET Method

UPDATE Method

1

sf_Level Two ID

Activity ID of level 2

                              ✓

                  Not Updatable

Mandatory field for updating records

2

sf_Application ID

UTA ID

                              ✓

                              ✓

Mandatory field for updating records

3

sf_Description

Description standard field

                              ✓

                              ✓

4

sf_Subject

Subject standard field

                              ✓

                              ✓

5

sf_Type ID

ID of level 2/3 type

                              ✓

                              ✓

Mandatory field for adding records

6

sf_Activity Type

Level 2/3 type name

                              ✓

                              ✓

7

sf_Parent ID

Parent object ID

                              ✓

                              ✓

Mandatory field for adding records

User "objectid" in place of "sf_Parent ID" for new L2 records

8

sf_Assign Person

Comma delimited list of user IDs in assigned standard field

                              ✓

                              ✓

9

sf_Contact Person

Comma delimited list of user IDs in contact standard field

                              ✓

                              ✓

10

sf_Location

Location standard field

                              ✓

                              ✓

11

sf_Start Date

Start date standard field

                              ✓

                              ✓

12

sf_End Date

End date standard field

                              ✓

                              ✓

13

sf_Duration

Duration standard field

                              ✓

                              ✓

14

sf_Amount

Amount standard field

                              ✓

                              ✓

15

sf_Status ID

Status ID of status. 0 if empty

                              ✓

                              ✓

Mandatory field for adding records

16

sf_Status

Status name

                              ✓

                              ✓

17

sf_Owner ID

User ID of owner. 0 if empty

                              ✓

                              ✓

18

sf_Owner

Name of owner. 0 if empty

                              ✓

                              ✓

19

sf_Updated By

Name of user who updated the record

                              ✓

                  Not Updatable

20

sf_Last Modified

Date the record was modified

                              ✓

                  Not Updatable

21

sf_Created By

Name of user who created the record

                              ✓

                  Not Updatable

22

sf_Created Date

Date record was created

                              ✓

                  Not Updatable

Level 3

See Level 2.


Multiple Address

 

Standard Field Name

Description

GET Method

UPDATE Method

1

sf_Address ID

Unique id in Multiple Address table

                              ✓

                  Not Updatable

Mandatory field for updating records

2

sf_Object ID

companyid / contactid / providerid / consumerid

                              ✓

                              ✓

Mandatory field for adding records

3

sf_Type ID

Multiple Address Type ID

                              ✓

                              ✓

Mandatory field for adding records

4

sf_Type

Type name

                              ✓

                              ✓

5

sf_Address

Address standard field

                              ✓

                              ✓

6

sf_Address 2

Address 2 standard field

                              ✓

                              ✓

7

sf_City

City standard field

                              ✓

                              ✓

8

sf_State / Province

Province standard field

                              ✓

                              ✓

9

sf_Zip / Postal Code

Postal code standard field

                              ✓

                              ✓

10

sf_Country

Country name

                              ✓

             Displays country name

                              ✓

Update using country id or country name

11

sf_Last Modified

date the record was last updated

                              ✓

                  Not Updatable

12

sf_Primary Address

Is primary address (1=yes, 0=no)

                              ✓

                              ✓

Mandatory field for adding records

13

sf_Updated By

Last updated user id

                              ✓

                  Not Updatable


Associations

not implemented at the moment.


See Also

JSON API (SmartConnect)
JSON API (SmartConnect) Prerequisite