Changes

SmartConnect - Appendix: Standard Field Names

30,182 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;"|✓

||

|-

||sf_Phone

||

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

||

|-

||sf_Fax

||

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

||

|-

||sf_Address

||

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

||

|-

||sf_Address 2

||

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

||

|-

||sf_City

||

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

||

|-

||sf_State / Province

||

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

||

|-

||sf_Country

||

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

||Update using Country ID or Country name as value

|-

||sf_Zip / Postal Code

||

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

||

|-

||sf_Web Site

||

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

||

|-

||sf_Longitude

||

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

||

|-

||sf_Latitude

||

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

||

|-

||sf_User Workflow

||ID of User workflow standard field

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

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

||

|-

||sf_Parent Company ID

||ID of Parent Company

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

||Mandatory field for adding records

|-

||sf_Primary Contact ID

||Primary Contact ID (0 if empty)

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

||

|-

||sf_Category ID List

||Comma delimited list of category IDs. (Starts and ends with a comma)

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

||

|-

||sf_Status ID

||Returns Status ID

| 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

||

|}

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

||

|-

||sf_State / Province

||

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

||

|-

||sf_Country

||

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

||

|-

||sf_Zip / Postal Code

||

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

||

|-

||sf_Company

||Name of user's company

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

||When updating, use Company ID or Company name as value

|-

||sf_Middle Name

||

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

||

|-

||sf_Longitude

||

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

||

|-

||sf_Latitude

||

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

||

|-

||sf_User Role

||Comma delimited list of role IDs. (Starts and ends with a comma)

| 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

||

|-

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

||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. 0 if empty.

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

||Mandatory field for adding records

|-

||sf_Status ID

||Returns Status ID

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

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

||

|}

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

||Update using Company ID as value

|-

||sf_Person

||Name of contact attached to Person standard field

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

||Update using User ID as value

|-

||sf_Status

||Returns Status name

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

||Update using Status ID as value

|-

||sf_Revenue

||Revenue standard field

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

||

|-

||sf_Currency

||Currency standard field

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

||

|-

||sf_Close Date

||Close Date standard field

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

||

|-

||sf_Modified Date

||Date record was last updated

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

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

||

|-

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

||

|-

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

||

|-

||sf_Description

||Returns value from Description standard field

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

||

|-

||sf_Requirement

||Requirement standard field

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

||

|-

||sf_Owner

||Returns name of level 1 owner standard field

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

||Update using Owner ID as value

|-

||sf_Branch

||Returns company name on Branch standard field

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

||

|-

||sf_Start Date

||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS

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

||

|-

||sf_Archived

||Flag (1=Archived, 0=Not Archived)

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

||

|-

||sf_Level One ID

||Returns unique Level 1 tracking ID

| 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

||Company ID of level 1 company/client field. 0 if empty

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

||

|-

||sf_Person ID

||User ID of level 1 people field. 0 if empty

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

||

|-

||sf_Branch ID

||Company ID of level 1 branch field. 0 if empty

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

||

|-

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

||

|-

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

||

|-

||sf_Duration

||Duration standard field

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

||

|-

||sf_Owner

||Returns name of level 2 owner standard field

| 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

||

|-

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

||

|-

||sf_End Date

||Returns End Date and Time in YYYY-MM-DD HH:MM:SS

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

||

|-

||sf_Whole Day Event

||Flag (Yes, No)

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

||

|-

||sf_Reminder Sent

||Flag (1=Yes 0=No)

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

||

|-

||sf_Follow-up Sent

||Flag (1=Yes 0=No)

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

||

|-

||sf_Reminder Type

||Returns ID of reminder type

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

||

|-

||sf_Follow-up Type

||Returns Id of follow-up type

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

||

|-

||sf_Assign Person

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

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

||

|-

||sf_Contact Person

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

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

||

|-

||sf_Description

||Returns value from Description standard field

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

||

|-

||sf_Amount

||Returns value from Amount standard field

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

||

|-

||sf_Parent Name

||Returns Name standard field from parent level 1

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

||

|-

||sf_Longitude

||

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

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

||

|-

||sf_Latitude

||

| 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

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

||

|-

||sf_Status Caption

||Returns Status caption

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

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

||

|-

||sf_Type Caption

||Returns level 2 type caption

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

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

||

|}

==Level 3==

~~See Level~~ {| 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;"|✓|||-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||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_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|||-||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;"|✓| style="text-align: center;"|✓|||-||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;"|✓|||-||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;"|✓| style="text-align: center;"|✓|||-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Parent Subject||Returns Subject field from 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;"|✓|||-||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;"|✓| style="text-align: center;"|✓|||-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Latitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Level Three ID||Returns unique level 3 ID| style="text-align: center;"|✓| 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;"|✓| 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;"|✓| 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;"|✓|||-||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|||-||sf_Type Caption||Returns level 3 type caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||} ==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;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Type ID||Address type ID| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Type||Address Type| 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_Zip / Postal Code||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Country||| 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|||-||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|||}

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

||

|}

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

||

|-

||sf_End Date

||

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

||

|-

||sf_Description

||

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

||

|-

||sf_Subject

||

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

||

|-

||sf_Status

||Returns transaction status name

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

||

|-

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

||

|-

||sf_Created By

||Name of user that created the record

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

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

||

|-

||sf_Type

||Transaction type

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

||Mandatory field for adding records

|}

==Notes==

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

|-

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

||

|-

||sf_Value

||Value of the variable

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

||

|-

||sf_Description

||Variable Description

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

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

← Older edit

Lalaine Songalia

Smartstaff

1,385

edits

Changes

SmartConnect - Appendix: Standard Field Names

SmartWiki