Open main menu

Changes

SmartConnect - Appendix: Standard Field Names

4,436 bytes added, 16:48, 25 September 2020
no edit summary
||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
||sf_Activity Type
||Returns level 2 type name
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Type ID as value
|-
||sf_Subject
||Returns level 2 subject
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Status
||Returns Status name
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Status ID as value
|-
||sf_Location
||Location standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Duration
||Duration standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Owner
||Returns name of level 2 owner standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Owner ID as value
|-
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Last Modified
||Date record was last updated
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created Date
||Date the record was created
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|Y✓
| 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;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_End Date
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Whole Day Event
||Flag (Yes, No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Reminder Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Follow-up Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Reminder Type
||Returns ID of reminder type
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Follow-up Type
||Returns Id of follow-up type
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Assign Person
||Comma delimited list of user IDs in assigned standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Contact Person
||Comma delimited list of user IDs in contact standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Description
||Returns value from Description standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Amount
||Returns value from Amount standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Parent Name
||Returns Name standard field from parent level 1
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Longitude
||
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Latitude
||
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Level Two ID
||Returns unique level 2 ID
| style="text-align: center;"|Y✓
| 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;"|Y✓| style="text-align: center;"|Y✓||Mandatory field for adding records<br /> <br /> User Use "objectid" in place of "sf_Parent ID" for new L2 records
|-
||sf_Type ID
||ID of level 2 template
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|-
||sf_Status ID
||Status ID of level 1 status. 0 if empty
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Application ID
||Returns UTA ID
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Type Caption
||Returns level 2 type caption
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Activity Type
||Returns level 3 type name
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Type ID as value
|-
||sf_Subject
||Returns level 3 subject
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Status
||Returns Status name
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Status ID as value
|-
||sf_Location
||Location standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Duration
||Duration standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Owner
||Returns name of level 3 owner standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Update using Owner ID as value
|-
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Last Modified
||Date record was last updated
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created Date
||Date the record was created
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|Y✓
| 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;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_End Date
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Whole Day Event
||Flag (Yes, No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Reminder Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Follow-up Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Reminder Type
||Returns ID of reminder type
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Follow-up Type
||Returns Id of follow-up type
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Parent Subject
||Returns Subject field from parent level 2
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Associated Parent
||Displays level 2 ID from soft-linked UTA
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Assign Person
||Comma delimited list of user IDs in assigned standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Contact Person
||Comma delimited list of user IDs in contact standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Description
||Returns value from Description standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Amount
||Returns value from Amount standard field
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Longitude
||
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Latitude
||
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Level Three ID
||Returns unique level 3 ID
| style="text-align: center;"|Y✓
| style="text-align: center;"|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
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓||Mandatory field for adding records<br /> <br /> User Use "objectid" in place of "sf_Parent ID" for new L3 records
|-
||sf_Type ID
||ID of level 3 template
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|-
||sf_Status ID
||Status ID of level 1 status. 0 if empty
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Application ID
||Returns UTA ID
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Type Caption
||Returns level 3 type caption
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
| 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;"|✓
||
|}
||sf_Start Date
||
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_End Date
||
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Description
||
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Subject
||
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Status
||Returns transaction status name
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||
|-
||sf_Modified Date
||Date record was last updated
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created Date
||Date the record was created
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||
||sf_Type
||Transaction type
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|-
||sf_Transaction ID
||Unique ID for the transaction record
| style="text-align: center;"|Y✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
||sf_Object ID
||Parent object id for the transaction
| style="text-align: center;"|Y✓| style="text-align: center;"|Y✓
||Mandatory field for adding records
|}
==See AlsoNotes==[[JSON 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 (SmartConnect)]] <br 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"[[JSON |-! width="20%"|API (SmartConnect) Prerequisite]]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:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]
Lalaine Songalia
Smartstaff
1,385
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/32151...38022’