Open main menu

Changes

SmartConnect - Appendix: Standard Field Names

10,152 bytes added, 16:48, 25 September 2020
no edit summary
==Field List Syntax==
{| class="wikitable"
|-
||
|-
!|Field List Syntax
||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
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||When updating, use Country Company ID or Country name Company name as value
|-
||sf_Middle Name
||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
||
|}
 
==Level 1==
| 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
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
|-
||sf_Status Caption
==Level 2==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- style! width="font-weight: bold; text-align: center;20%"|API Field Reference! width="25%"| Field Description! style="bordertext-align: 1px solid graycenter;" width="515%"|Allow Get/List''' ''' | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Update'''Standard Field Name''' | style="border: 1px solid gray;" ! width="25%"|External Notes'''Description'''|-||sf_Activity Type||Returns level 2 type name| style="bordertext-align: 1px solid graycenter;" width="25%"|'''GET Method'''✓| style="bordertext-align: 1px solid graycenter;" width="20%"|✓'''UPDATE Method'''||Update using Type ID as value
|-
||sf_Subject
||Returns level 2 subject
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||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_Level Two ID|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Activity ID |-||sf_Owner||Returns name of level 2owner 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
||
'''                  Not Updatable'''
 
Mandatory field for updating records
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
2|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Application ID|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
UTA ID|-||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;"|✓
||
                              ✓
 
Mandatory field for updating records
 
|-
||sf_Reminder Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
3|-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Description|-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Description standard field|-||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;"|✓
||
4|-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Subject|-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Subject |-||sf_Parent Name||Returns Name standard fieldfrom parent level 1| style="text-align: center;"|✓| style="text-align: center;"|✓
||
                              ✓
 
||
                              ✓
 
|-
||sf_Longitude
||
5| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Type ID|-||sf_Latitude
||
ID of level 2/3 type| 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
Mandatory field for adding 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;"|✓
||
6|-||sf_Application ID||Returns UTA ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Activity Type|-||sf_Status Caption||Returns Status caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Level |-||sf_Type Caption||Returns level 2/3 type namecaption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
                              ✓|}
==Level 3==
{| 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;"|✓
||
7|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Parent |-||sf_Owner||Returns name of level 3 owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner IDas value|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Parent object ID|-||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
||
                              ✓
 
Mandatory field for adding records
 
User "objectid" in place of "sf_Parent ID" for new L2 records
 
|-
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
8|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Assign Person|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Comma delimited list of user IDs in assigned standard field|-||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;"|✓
||
9|-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Contact Person|-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Comma delimited list of user IDs in contact standard |-||sf_Parent Subject||Returns Subject fieldfrom 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;"|✓
||
10|-||sf_Locationsf_Contact Person||Location 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;"|✓
||
11
 
||
sf_Start Date
 
||
Start date standard field
 
||
                              ✓
 
||
                              ✓
 
|-
||sf_Amount
||Returns value from Amount standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
12
 
||
sf_End Date
 
||
End date standard field
 
||
                              ✓
 
||
                              ✓
 
|-
||sf_Longitude
||
13 |style="text-align: center;"|sf_Duration✓|style="text-align: center;"|Duration standard field ||                              ✓Not Updatable
||
                              ✓
 
|-
||sf_Latitude
||
14 |style="text-align: center;"|sf_Amount✓|style="text-align: center;"|Amount standard fieldNot Updatable
||
                              ✓
 
||
                              ✓
 
|-
||sf_Level Three ID
||Returns unique level 3 ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
15 ||sf_Status ID ||Status ID of status. 0 if empty ||                              ✓ ||                              ✓Mandatory field for updating records
Mandatory field for adding Use "recordid" in place of "sf_Level Three ID" in updating records
|-
||16sf_Parent ID||sf_StatusReturns level 2 ID from parent record|style="text-align: center;"|Status name✓|style="text-align: center;"|                              ✓ ||                              ✓Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L3 records
|-
||17 ||sf_Owner sf_Type ID ||User ID of owner. 0 if emptylevel 3 template|style="text-align: center;"|                              ✓ |style="text-align: center;"|                              ✓||Mandatory field for adding records
|-
||18 ||sf_Ownersf_Status ID||Name Status ID of ownerlevel 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;"|✓
||
19
 
||
sf_Updated By
 
||
Name of user who updated the record
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|-
||sf_Application ID
||Returns UTA ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
20
 
||
sf_Last Modified
 
||
Date the record was modified
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
21
 
||
sf_Created By
 
||
Name of user who created the record
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|-
||sf_Type Caption
||Returns level 3 type caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
22
 
||
sf_Created Date
 
||
Date record was created
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|}
 
==Level 3==
See Level 2.
 
 
==Multiple Address==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- ! width="20%"|API Field Reference! width="25%"|Field Description! style="font-weight: bold; text-align: center;"width="15%"|Allow Get/List| ! style="bordertext-align: 1px solid graycenter;" width="515%"| Allow Update| style="border: 1px solid gray;" ! width="25%"|External Notes|-'''Standard Field Name'''||sf_Address ID||Unique id in Multiple Address table| style="bordertext-align: 1px solid graycenter;" width|✓| style="25%text-align: center;"|Not Updatable||Mandatory field for updating records|-'''Description'''||sf_Object ID||Object ID of parent record. Could be companyid, contactid.| style="bordertext-align: 1px solid graycenter;" width|✓| style="25%text-align: center;"|✓||Mandatory field for adding records|-'''GET Method'''||sf_Type ID||Address type ID| style="bordertext-align: 1px solid graycenter;" width|✓| style="20%text-align: center;"|✓'''UPDATE Method'''||Mandatory field for adding records
|-
||sf_Type
||Address Type
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||sf_Address
||
sf_Address ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Unique id in Multiple Address table|-||sf_Address 2
||
                              | style="text-align: center;"|✓| style="text-align: center;"|✓
||
'''                  Not Updatable'''
 
Mandatory field for updating records
 
|-
||sf_City
||
2| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Object ID|-||sf_State / Province
||
companyid / contactid / providerid / consumerid| style="text-align: center;"|✓|style="text-align: center;"|                              ✓ 
||
                              ✓
 
Mandatory field for adding records
 
|-
||sf_Zip / Postal Code
||
3| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Type ID|-||sf_Country
||
Multiple Address Type ID| 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
||
                              ✓
 
Mandatory field for adding records
 
|-
||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
||
4|}
==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
||
sf_Type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Type name|}
==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
||
5| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address|-||sf_Description
||
Address standard field| style="text-align: center;"|✓|style="text-align: center;"|                              ✓ 
||
                              ✓
 
|-
||sf_Subject
||
6| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address 2|-||sf_Status||Returns transaction status name| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Address 2 standard field|-||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
||
7|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_City|-||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==City standard fieldNotes 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
||
8|-||sf_Content||Contents of the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_State / Province|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Province standard field|-||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;"|✓
||
9|-||sf_Value||Value of the variable| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Zip / Postal Code|-||sf_Description||Variable Description| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Postal code standard field|}
==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
||
10|-||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
||
sf_Country
 
||
Country name
 
||
''                              ✓''
 
''             Displays country name''
 
||
''                              ✓''
 
''Update using country id or country name<br />''
 
|-
||roleid
||Connection roleid between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
11
 
||
sf_Last Modified
 
||
date the record was last updated
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|-
||rolename
||Connection rolename between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
12
 
||
sf_Primary Address
 
||
Is primary address (1=yes, 0=no)
 
||
                              ✓
 
||
                              ✓
 
Mandatory field for adding records
 
|-
||associationid
||Unique identifier for the consumer/provider relationship table
| style="text-align: center;"|✓
| style="text-align: center;"| 
||
13
 
||
sf_Updated By
 
||
Last updated user id
 
||
                              ✓
 
||
'''                  Not Updatable'''
 
|}
 
 
==Associations==
not implemented at the moment.
 
 
==See Also==
[[JSON API (SmartConnect_-_RESTful_API|SmartConnect)]] <br />[[JSON - RESTful API (SmartConnect) Prerequisite]]  
[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]
Lalaine Songalia
Smartstaff
1,385
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/32145...38022’