Changes

SmartConnect - Appendix: Standard Field Names

24,276 bytes added, 16:48, 25 September 2020

no edit summary

The following lists the database field names associated with [[Standard Fields]].~~ ~~ ~~These are used in JSON API (SmartConnect). ~~ ~~== Field List Syntax ==~~

These are used in JSON API (SmartConnect).

==Field List Syntax==

{| class="wikitable"

|

|-

!|Field List Syntax!|Example

|-

||Separate values with ";;" ||sf_Name;;cf_MyFieldName;;cf_MyFieldssid

|-

||Prefix Standard fields with "sf_"||sf_Name

|}

==Companies==

{| 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%"|Notes External|-||sf_Name||Name of current company| style="text-align: center;"|✓| style="text-align: ~~800px~~center; ~~height~~"|✓|||-||sf_Phone||| style="text-align: ~~200px~~center;"|✓| style="text-align: center;"|✓|||-||sf_Fax||| 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;"|✓||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

||

~~'''Standard Field Name'''~~|}

==Users==

{| 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%"|Notes External

|-

||sf_First Name

||

| style="text-align: center;"|✓

||

|-

||sf_Last Name

||

| style="text-align: center;"|✓

||

|-

||sf_Email

||

| style="text-align: center;"|✓

||

|-

||sf_Title

||

| style="text-align: center;"|✓

||

|-

||sf_Prefix

||

| style="text-align: center;"|✓

||

|-

||sf_Suffix

||

| style="text-align: center;"|✓

||

|-

||sf_Phone

||

| style="text-align: center;"|✓

||

|-

||sf_Phone Ext.

||

| style="text-align: center;"|✓

||

|-

||sf_Address

||

| style="text-align: center;"|✓

||

|-

||sf_Address 2

||

| style="text-align: center;"|✓

||

|-

||sf_City

||

| style="text-align: center;"|✓

||

~~'''Description'''~~|-||sf_State / Province

||

~~'''GET Method'''~~| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~'''UPDATE Method'''~~

|-

||sf_Country

||

1| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Zip / Postal Code

||

~~sf_Company ID~~| 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. (0 if new company)~~ID or Company name as value|-||sf_Middle Name

||

| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~'''X'''~~

|-

||sf_Longitude

||

| style="text-align: center;"|✓

||

2|-||sf_Latitude

||

~~sf_Parent Company~~| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Parent company name~~|-||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;"|✓

||Update using ID as value

|-

||sf_User Type

||10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)

| 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

||

3|-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Parent Company ID~~|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~Parent~~ |-||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 id. 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

||

4|}

==Level 1==

{| 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%"|Notes External

|-

||sf_Application Type

||Returns level 1 template name

| style="text-align: center;"|✓

||Update using Type ID as value

|-

||sf_Application Name

||Returns value of Name standard field

| style="text-align: center;"|✓

||

|-||sf_Customer||Name of company on Client standard field| style="text-align: center;"|✓| 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 IDas value|-||sf_Revenue||Revenue standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Status id~~|-||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

||

5|-||sf_Modified By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Status Caption~~|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~Status Caption~~|-||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;"|✓

||

6|-||sf_Requirement||Requirement standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Status~~|-||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;"|✓

||

~~Status~~|-||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

||

7Mandatory field for updating records

||~~sf_Is External~~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;"|✓

||

~~Flag (~~|-||sf_Person ID||User ID of level 1~~=external,~~ people field. 0if empty| style=~~internal)~~"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;"|✓

||Mandatory field for adding records Update using Type ID as value

|-

||sf_Status ID

||Status ID of level 1 status. 0 if empty

| style="text-align: center;"|✓

||Mandatory field for adding records Update using Status ID as value

|-

||sf_Owner ID

||ID of level 1 owner.

| style="text-align: center;"|✓

||

8|-||sf_Application ID||Returns UTA ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Owner ID~~|-||sf_Status Caption||Returns Status caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~user who created the company~~|-||sf_Type Caption||Returns level 1 template caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

|}

==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 2 type name

| style="text-align: center;"|✓

||Update using Type ID as value

|-

||sf_Subject

||Returns level 2 subject

| style="text-align: center;"|✓

||

|-

||sf_Status

||Returns Status name

| style="text-align: center;"|✓

||Update using Status ID as value

|-

||sf_Location

||Location standard field

| style="text-align: center;"|✓

||

9|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Primary Contact~~ |-||sf_Owner||Returns name of level 2 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

||

|-||sf_Last Modified||Date record was last updated| style="text-align: ~~Primary contact ID. (0 if empty)~~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

||

10|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Primary Contact~~|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Primary contact name~~|-||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;"|✓

||

11|-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Name~~|-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Name~~ |-||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;"|✓

||

12|-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Address~~|-||sf_Parent Name||Returns Name standard field from parent level 1| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Address standard field~~|-||sf_Longitude

||

| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

|-

||sf_Latitude

||

13| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Address~~ |-||sf_Level Two ID||Returns unique level 2ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~Address 2 standard~~ Mandatory fieldfor 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;"|✓

||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

| 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;"|✓

||Mandatory field for adding records

|-

||sf_Owner ID

||ID of level 1 owner.

| style="text-align: center;"|✓

||

|-

||sf_Application ID

||Returns UTA ID

| style="text-align: center;"|✓

| style="text-align: center;"|Not Updatable

||

14|-||sf_Status Caption||Returns Status caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_City~~|-||sf_Type Caption||Returns level 2 type caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~City standard field~~|}

==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;"|✓

||Update using Type ID as value

|-

||sf_Subject

||Returns level 3 subject

| 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;"|✓

||

15|-||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_State / Province~~|-||sf_Last Modified||Date record was last updated| 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_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;"|✓

||

16|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Zip / Postal Code~~|-||sf_Whole Day Event||Flag (Yes, No)| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Postal code standard field~~|-||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;"|✓

||

17|-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Country~~|-||sf_Parent Subject||Returns Subject field from parent level 2| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Country name~~|-||sf_Associated Parent||Displays level 2 ID from soft-linked UTA| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~''Displays country name''~~|-||sf_Assign Person||Comma delimited list of user IDs in assigned standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~''Update using country id''~~

|-

||sf_Contact Person

||Comma delimited list of user IDs in contact standard field

| style="text-align: center;"|✓

||

18|-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Phone~~|-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Phone standard field~~|-||sf_Longitude

||

| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

|-

||sf_Latitude

||

| style="text-align: center;"|✓

| style="text-align: center;"|Not Updatable

||

19|-||sf_Level Three ID||Returns unique level 3 ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Fax~~Mandatory field for updating records

||~~Fax standard field~~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;"|✓

||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

| 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;"|✓

||Mandatory field for adding records

|-

||sf_Owner ID

||ID of level 1 owner.

| 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

||

20|-||sf_Type Caption||Returns level 3 type caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Web Site~~|}

==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;"|✓

||Mandatory field for adding records

|-

||sf_Type ID

||Address type ID

| style="text-align: center;"|✓

||Mandatory field for adding records

|-

||sf_Type

||Address Type

| style="text-align: center;"|✓

||

~~Website standard field~~|-||sf_Address

||

| style="text-align: center;"|✓| style="text-align: center;"|✓

||

|-

||sf_Address 2

||

21| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_City

||

~~sf_Category List~~| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Comma delimited list of category IDs. (Starts and ends with a comma)~~|-||sf_State / Province

||

| style="text-align: center;"|✓| style="text-align: center;"|✓

||

|-

||sf_Zip / Postal Code

||

22| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~sf_Last Updated~~|-||sf_Country

||

~~date the record was last updated on SmartSimple~~| 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

||

~~'''X'''~~

|-

||sf_Primary Address

||Flag (1=Yes, 0=No)

| 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

||

23|}

==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_Last Updated By~~| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~Last updated user 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

||

24| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Description

||

~~sf_Created Date~~| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~date the record was last created on SmartSimple~~|-||sf_Subject

||

| style="text-align: center;"|✓| style="text-align: center;"|✓

||

~~'''X'''~~

|-

||sf_Status

||Returns transaction status name

| style="text-align: center;"|✓

||

25|-||sf_Modified Date||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~sf_Created~~ |-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable

||

~~Created by user name~~|-||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

||

~~'''X'''~~|-||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

|}

==~~Users~~Notes==* '''sf_User ID''': User ID (0 if new user)* '''sf_Is External''': Flag (1=external, 0=internal)* '''sf_Company ID''': ID of user's companyNotes can only be retrieved via GET and LIST. ~~0 if empty.~~* '''sf_Company''': name of user's company.* '''sf_Title''': Title standard field.* '''sf_Prefix''': Prefix standard field.* '''sf_Suffix''': Suffix standard field.* '''sf_First Name''': First name standard field.* '''sf_Last Name''': Last name standard field.* '''sf_Email''': Email standard field.* '''sf_Address''': Address standard field.* '''sf_Address 2''': Address 2 standard field.* '''sf_City''': City standard field.* '''sf_State / Province''': Province standard field.* '''sf_Country''': name of country field. 0 if empty.* '''sf_Country ID''': ID of country field. 0 if empty.* '''sf_Zip / Postal Code''': Postal code standard field.* '''sf_Phone''': Phone standard field.* '''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 They cannot be created or ~~Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access')~~* '''sf_User Type''': 10 ('User'), 30 ('Local User Administrator'), 40 ('Global User Administrator')* '''sf_Status''': status ID of user* '''sf_Updated By''': name of user who updated the record.* '''sf_Last Updated''': date record was last updated.* '''sf_Created Date''': date record was created.* '''sf_Created By''': name of user who created the recordvia SmartConnect.

{| class="wikitable" width=~~Level 1~~"85%" cellpadding="5px" align="center"* '''sf_Level One ID''': Tracking ID of level 1.|-! width="20%"|API Field Reference* '''sf_Application ID''': UTA ID.! width="25%"|Field Description* '''sf_Company ID'''! style="text-align: ~~Company ID of level 1 company~~center;" width="15%"|Allow Get/~~client field. 0 if empty.~~List* '''sf_Branch ID'''! style="text-align: ~~Company~~ center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Note ID ~~of level 1 branch field. 0 if empty.~~* '''sf_Person ||Unique ID~~'''~~for the Note record| style="text-align: ~~User ID of level 1 people field. 0 if empty.~~center;"|✓* '''sf_Person'''| style="text-align: ~~name of User for level 1 people field.~~ center;"|Not Updatable|||-* '''||sf_Type ~~ID''': ID of level 1 template.~~* '''sf_Application Template ||Note Type~~'''~~| style="text-align: ~~Level 1 template type name.~~center;"|✓* '''sf_Application Name'''| style="text-align: ~~Name standard field.~~center;"|Not Updatable* '''sf_Description''': Description standard field.||* '''sf_Requirement''': Requirement standard field.|-* '''sf_Status ||sf_Type ID~~''': Status~~ ||Type ID ~~of level 1 status. 0 if empty.~~* '''sf_Status'''| style="text-align: ~~Name of level 1 status.~~center;"|✓* '''sf_Revenue'''| style="text-align: ~~Revenue standard field.~~center;"|Not Updatable|||-* '''sf_Start Date''': Start date standard field.||sf_Content* '''sf_End Date''': End date standard field.||Contents of the note* '''sf_Close Date'''| style="text-align: ~~Close date standard field.~~center;"|✓* '''sf_Probability'''| style="text-align: ~~Probability standard field.~~center;"|Not Updatable* '''sf_Owner ID''': ID of level 1 owner.||* '''sf_Owner''': Name of level 1 owner.|-* '''sf_Modified ||sf_Created By~~''':~~ ||Name of user ~~who modified~~ that created the record.* '''sf_Modified Date'''| style="text-align: ~~Date the record was modified.~~center;"|✓* '''sf_Created By'''| style="text-align: ~~Name of user who created the record.~~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|||}

==~~Level 2~~System Variables==* '''sf_Level Two ID''': Activity ID of level 2.{| class="wikitable" width="85%" cellpadding="5px" align="center"|-* '''sf_Application ID''': UTA ID.! width="20%"|API Field Reference* '''sf_Description''': ! width="25%"|Field Description ~~standard field.~~* '''sf_Subject'''! style="text-align: ~~Subject standard field.~~center;" width="15%"|Allow Get/List* '''sf_Type ID'''! style="text-align: ~~ID of level 2/3 type.~~center;" width="15%"|Allow Update! width="25%"|External Notes|-* '''sf_Activity Type''': Level 2 type name.||sf_ID* '''sf_Parent ID''': Parent object ||System variable record ID.* '''sf_Assign Person'''| style="text-align: ~~Comma delimited list of user IDs in assigned standard field.~~center;"|✓* '''sf_Contact Person'''| style="text-align: ~~Comma delimited list of user IDs in contact standard field.~~center;"|Not Updatable* '''sf_Location''': Location standard ||Mandatory field.for updating records* '''sf_Start Date''': Start date standard field.|-* '''sf_End Date''': End date standard field.||sf_Name* '''sf_Duration''': Duration standard field.||Variable Name* '''sf_Amount'''| style="text-align: ~~Amount standard field.~~center;"|✓* '''sf_Status ID'''| style="text-align: ~~Status ID of status. 0 if empty.~~center;"|✓* '''sf_Status''': Status name.||* '''sf_Owner ID''': User ID of owner. 0 if empty.|-* '''sf_Owner''': Name of owner. ||sf_Value* '''sf_Updated By''': Name ||Value of ~~user who updated~~ the ~~record.~~ variable* '''sf_Last Modified'''| style="text-align: ~~Date the record was modified.~~ center;"|✓* '''sf_Created By'''| style="text-align: ~~Name of user who created the record.~~ center;"|✓|||-* '''sf_Created Date''': Date the record was created.||sf_Description||Variable Description| style="text-align: center;"|✓| style=~~Level 3==~~"text-align: center;"|✓||~~See Level 2.~~|}

==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==

[[~~JSON API (~~SmartConnect_-_RESTful_API|SmartConnect~~)]] [[JSON~~ - RESTful API ~~(SmartConnect) Prerequisite~~]]~~ ~~

[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]

← Older edit

Lalaine Songalia

Smartstaff

1,385

edits

Changes

SmartConnect - Appendix: Standard Field Names

SmartWiki