This article provides sample configurations for each SmartConnect action type, organized by the function category. Use this reference when configuring SmartConnect functions in your SmartSimple instance. For steps to create a function, see Create a SmartConnect Function.
Who: SmartConnect functions are for Global User Administrators.
Metadata
Use the Metadata action type (Get Meta) to retrieve field metadata for a selected object type. No parameters are needed to retrieve metadata.
Get Metadata of a Universal Tracking Application (3.01.1)
Function Name – 3.01.1 Get Metadata Sample 1: CMS360°: Application Metadata
Description – Retrieves metadata for a Universal Tracking Application object.
Object Type – Case Management 360° – Case (UTA/module Level 1)
Action Type – Get Meta
Field List – levelone.*;;leveltwo.*;;levelthree.*
No parameters are needed to retrieve metadata.
Sending API request using cURL:
curl -X GET -k -i 'https://api.smartsimple.com/API/1/levelone/
?url=https://api.smartsimple.com/API/1/levelone/
&companyid=825646
&alias=api
&username=smartconnectdemo@smartsimple.com
&password=********************
&apitoken=U2N4RwUBTn5XZldZXFdfWX1@C2JAWXVuAjIF'
Get Metadata of Organizations (3.01.2)
Function Name – 3.01.2 Get Metadata Sample 2: Organizations Metadata
Description – Retrieves metadata from Organizations.
Object Type – Company
Action Type – Get Meta
Field List – companies.*
No parameters are needed to retrieve metadata.
Get Metadata from Contacts (3.01.3)
Function Name – 3.01.3 Get Metadata Sample 3: Users Metadata
Description – Retrieves metadata from Users.
Object Type – User
Action Type – Get Meta
Field List – contacts.*
No parameters are needed to retrieve metadata.
Report
Use the Report action type to retrieve the results of a query from an existing report using the reportid.
Report Query (3.02.1)
Function Name – 3.02.1 Get Report Sample 1: Report Query
Description – Retrieves data from a report.
Object Type – Report
Action Type – Reports - Query
Field List – Not displayed for Report object type. Instead, users select the reports to be listed from the Reports drop-down list.
Sample A – Report query on assessors grouped by specialty
Description – Displays the number of assessors based on their specialty.
Sample B – Report query on specialties with more than 5 assessors
Description – Shows a list of specialties with more than 5 assessors per specialty.
Sample C – Report query on grants grouped by organization
Description – Shows a list of applications filtered by Approved Proposal status grouped by organization.
Sample D – Report query on grants grouped by focus area
Description – Displays a list of applications grouped by focus area.
Sample E – Report query on payments grouped by grant type
Description – Displays the payment amount for each grant grouped by organization.
Get
Use the Get action type to retrieve all fields from the Field List of a single record based on the recordid of an object type.
Retrieve a Single Organization Record (3.03.1)
Function Name – 3.03.1 Get Method Sample 1: Retrieve a Single Organization Record
Description – Retrieves a single record from the organization using the recordid: Company ID. The function retrieves the fields listed under Field List.
Object Type – Company
Action Type – Get
Field List – sf_Company ID;;sf_Name;;sf_Address;;sf_City;;sf_Country;;sf_Zip / Postal Code;;cf_EIN Number;;sf_Mission Statement
Retrieve a Single Contact Record (3.03.2)
Function Name – 3.03.2 Get Method Sample 2: Retrieve a Single Contact Record
Description – Retrieves a single record from the user table using the User ID. The function retrieves the fields listed under Field List.
Object Type – User
Action Type – Get
Field List – sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email
Retrieve a Single Grant Application Record (3.03.3)
Function Name – 3.03.3 Get Method Sample 3: Retrieve a Single Grant Application Record
Description – Retrieves a single record from the Universal Tracking Application Level 1 using the Opportunity ID.
Object Type – Submission Manager – Grant
Action Type – Get
Field List – cf_Project Name;;cf_Submission Number;;sf_Application Type;;sf_Status;;sf_Customer;;sf_Owner;;cf_Focus Area;;cf_Amount Requested;;cf_Program Area;;cf_Location;;cf_Proposed Start Date;;cf_Proposed End Date
Retrieve a Single Grant Application Payment Record (3.03.4)
Function Name – 3.03.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record
Description – Retrieves a single record from the Universal Tracking Application Level 2 using the Event ID.
Object Type – Submission Manager – Activity
Action Type – Get
Field List – sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes
Retrieve a System Variable Record (3.03.5)
Function Name – 3.03.5 System Variables Sample 1: Get
Description – Retrieves information on system variables by searching the System Variable ID.
Object Type – System Variables
Action Type – Get
Field List – sf_ID;;sf_Name;;sf_Value
--Begin custom parameter--
recordid: 3601
--End custom parameter--
List
Use the List action type to retrieve a list of records from the selected object type.
List custom parameters:
criteria (optional) – A JSON array with nodes: andor, field, operator, and value.
andor: "and" or "or" (use "(" and ") and (" for bracketed logic)
field: name of the standard or custom field for the condition
operator: =, >, >=, <=, <, <>, !=, like, not like
value: value for the filter
sortby (optional) – A JSON array with nodes: field and direction ("asc" or "desc").
othersettings (optional):
getstorevalue: 0 = display value; 1 = stored value (database value, e.g., 25000 vs $25,000)
keyformat: 0 = use Field List configuration; 1 = use field names; 2 = use field IDs
Retrieve a List of Contacts (3.04.1)
Function Name – 3.04.1 List Method Sample 1: Retrieve a list of Contacts
Description – Retrieves a list of contacts based on specified criteria.
Object Type – User
Action Type – List
Field List – sf_User ID;;sf_First Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code
Sample 1A – Contacts where first name begins with "J", sorted by first name ascending.
--Begin custom parameter--
criteria : [{"andor":"or","field":"sf_First Name","operator":"like","value":"J%"}]
sortby : [{"field":"sf_First Name","direction":"asc"}]
othersettings :
--End custom parameter--
Sample 1B – Contacts where first name begins with "S" and address contains "Peter", sorted by first name ascending.
--Begin custom parameter--
criteria : [{"andor":"or","field":"sf_First Name","operator":"like","value":"S%"},
{"andor":"and","field":"sf_Address","operator":"like","value":"%Peter%"}]
sortby : [{"field":"sf_First Name","direction":"asc"}]
othersettings :
--End custom parameter--
Retrieve a List of Organizations (3.04.2)
Function Name – 3.04.2 List Method Sample 2: Retrieve a list of Organizations
Description – Retrieves a list of organizations.
Object Type – Company
Action Type – List
Field List – sf_Company ID;;sf_Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code;;cf_Mission Statement
Sample 2A – Organizations with name starting with "Br".
--Begin custom parameter--
criteria : [{"andor":"and","field":"sf_Name","operator":"like","value":"Br%"}]
sortby :
keyformat:
--End custom parameter--
Sample 2B – Organizations with name starting with "Br" and address containing "Ave", sorted by name ascending.
--Begin custom parameter--
criteria : [{"andor":"and","field":"sf_Name","operator":"like","value":"Br%"},
{"andor":"and","field":"sf_Address","operator":"like","value":"%Ave%"}]
sortby : [{"field":"sf_Name","direction":"asc"}]
othersettings :
--End custom parameter--
Retrieve a List of Claims (3.04.3)
Function Name – 3.04.3 List Method Sample 3: CMS360° – Retrieve a list of claims
Description – Retrieves a list of claims by professors sorted by organization name in descending order.
Object Type – Case Management 360° – Case
Action Type – List
Field List – sf_Application Template Type;;sf_Customer;;cf_Claim;;cf_Nature of Injury / Comments on Claim;;sf_Activity List
--Begin custom parameter--
criteria : [{"andor":"and","field":"cf_Nature of Injury / Comments on Claim","operator":"like","value":"%professor%"}]
sortby : [{"field":"sf_Customer","direction":"desc"}]
othersettings :
--End custom parameter--
List Files of an Existing Organization (3.04.4.1)
Function Name – 3.04.4.1 List Files Method Sample 1: from an existing organization
Description – Retrieves the list of files from the organization using the Company ID.
Object Type – Company
Action Type – Files - List
Parameters used:
objectid = Company ID
fieldid = Custom Field ID of an organization field that is either single file type or multiple file type
--Begin custom parameter--
objectid : 1688407
fieldid : 1523157
othersettings :
--End custom parameter--
List Files from an Existing Application (3.04.4.2)
Function Name – 3.04.4.2 List Files Method Sample 2: from an existing application
Description – Retrieves the list of files of an existing application using the Opportunity ID.
Object Type – Submission Manager – Grant
Action Type – Files - List
Parameters used:
objectid = Opportunity ID
fieldid = Custom Field ID of UTA/module Level 1 that is either single file type or multiple file type
--Begin custom parameter--
objectid : 1688407
fieldid : 1523157
getstorevalue :
--End custom parameter--
List Notes from an Existing Application (3.04.5.1)
Function Name – 3.04.5.1 List Notes Method Sample 1: from an existing application
Description – Retrieves all notes associated with an existing application using the Opportunity ID.
Object Type – Submission Manager – Grant
Action Type – Notes - List
Field List – sf_Type Name;;sf_Content;;sf_Created By;;sf_Created By ID;;sf_Created Date;;sf_Note ID;;sf_Object ID;;sf_Type ID;;sf_Note Content
Parameters used:
objectid = Opportunity ID
--Begin custom parameter--
objectid : 8276124
--End custom parameter--
List All Multiple Addresses of an Existing Organization (3.04.6.1)
Function Name – 3.04.6.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an existing Organization
Description – Retrieves all multiple addresses of an existing organization using the Company ID.
Object Type – Company
Action Type – Multiple Addresses - List
Field List – sf_Address;;sf_Address 2;;sf_City;;sf_State / Province;;sf_Country;;sf_Zip / Postal Code;;sf_Primary Address;;sf_Type;;sf_Type ID;;sf_Updated By;;sf_Last Modified;;sf_Object ID;;sf_Address ID
Parameters used:
objectid = Company ID
--Begin custom parameter--
objectid : 1688407
--End custom parameter--
List Contact Associations from an Existing Application (3.04.7.1)
Function Name – 3.04.7.1 List Associations Method Sample 1: Contact associations from an existing application
Description – Retrieves the list of contacts associated with an existing application using the Opportunity ID.
Object Type – Submission Manager – Grant
Action Type – Associations - List
Field List – contacts.*
Parameters used:
objectid = Opportunity ID
type = "contacts" or "organizations"
--Begin custom parameter--
objectid: 10697883
type : contacts
--End custom parameter--
List Organization Associations from an Application (3.04.7.2)
Function Name – 3.04.7.2 List Associations Method Sample 2: Organization associations from an existing application
Description – Retrieves the list of organizations associated with an existing application using the Opportunity ID.
Object Type – Submission Manager – Grant
Action Type – Associations - List
Field List – organizations.*
Parameters used:
objectid = Opportunity ID
type = "contacts" or "organizations"
--Begin custom parameter--
objectid: 10697883
type : organizations
--End custom parameter--
List All System Variables (3.04.8.1)
Function Name – 3.04.8.1 System Variables Sample 1: List
Description – Retrieves all system variables.
Object Type – System Variables
Action Type – List
Field List – sf_ID;;sf_Name;;sf_Value
No parameters are needed to retrieve all global system variables.
Update
Use the Update action type to create new records or update existing records based on the selected object type.
Create or Update an Organization Record (3.05.1.1)
Function Name – 3.05.1.1 Create/update organization record
Description – Creates new records or updates existing organization records.
Object Type – Company
Action Type – Update
Field List – sf_Name;;sf_Is External;;sf_Parent Company ID;;sf_Address;;sf_Address 2;;sf_City;;sf_State / Province;;sf_Zip / Postal Code;;sf_Country;;cf_EIN Number;;cf_1523156;;sf_Category ID List
Sample 1A – Create a new organization record.
Mandatory fields to add a new record:
recordid: set to "0" to create a new record
sf_Parent Company ID: the parent company for the organization being added
sf_Is External: "1" for external, "0" for internal
sf_Category ID List: category of the company being added
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Parent Company ID":"826082","sf_Is External":"1",
"sf_Name":"Test 1 Company","sf_Country":"10","sf_Address":"111 Peter Street",
"sf_City":"Toronto","sf_State / Province":"ON","cf_EIN Number":"101010101",
"sf_Category ID List":",3884,"}]
--End custom parameter--
Sample 1B – Update an existing organization record.
Mandatory fields to update an existing record:
recordid: the Company ID of the existing organization to update
--Begin custom parameter--
jsonrset : [{"recordid":"1688403","sf_Name":"Change Company thru API"}]
--End custom parameter--
Create or Update a User Record (3.05.1.2)
Function Name – 3.05.1.2 Create/update user record
Description – Creates new records or updates existing user records.
Object Type – User
Action Type – Update
Field List – sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email;;sf_Company ID;;sf_Is External;;sf_Role ID List
Sample 1C – Create two new user records.
Mandatory fields to add new records:
recordid: set to "0" to create a new record
sf_Company ID: the company to associate the user with
sf_Is External: "1" for external, "0" for internal
sf_Role ID List: role ID of the user
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Company ID":"1688403","sf_Is External":"1",
"sf_First Name":"John","sf_Last Name":"Doe","sf_Role ID List":",14078,"},
{"recordid":"0","sf_Company ID":"1688403","sf_Is External":"1",
"sf_First Name":"Mary","sf_Last Name":"Doe","sf_Role ID List":",14078,"}]
--End custom parameter--
Sample 1D – Update the last name of existing user records.
Mandatory fields to update records:
recordid: the User ID of the existing user
--Begin custom parameter--
jsonrset : [{"recordid":"87983424","sf_Last Name":"Change Last Name thru API"},
{"recordid":"88159403","sf_Last Name":"Smith"}]
--End custom parameter--
Create or Update a UTAModule Level 1 Record (3.05.1.3)
Function Name – 3.05.1.3 Create/update UTA/module Level 1 record
Description – Creates new records or updates UTA/module Level 1 records.
Object Type – Submission Manager – Grant
Action Type – Update
Field List – sf_Name;;sf_Type ID;;sf_Status ID;;sf_Company ID;;sf_Person ID;;sf_Owner ID;;sf_Start Date;;sf_End Date;;cf_1523228
Sample 1E – Add a new UTA/module Level 1 record.
Mandatory fields to add a new record:
recordid: set to "0" to create a new record
sf_Type ID: assigned Type ID of the new Level 1 record
sf_Status ID: assigned Status ID of the new Level 1 record
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Type ID":"20654","sf_Status ID":"25178",
"sf_Name":"Test 1 Application","sf_Customer":"1767970",
"sf_Person":"88159402","sf_Owner":"3108429",
"sf_Start Date":"2018-01-01","sf_End Date":"2018-12-31"}]
--End custom parameter--
Sample 1F – Update the value of a custom field in an existing UTA Level 1 record.
Mandatory fields to update an existing record:
recordid: the Opportunity ID of the existing record
--Begin custom parameter--
jsonrset : [{"recordid":"8276165","cf_1523228":"Change value of this custom field thru API function"}]
--End custom parameter--
Create or Update a UTA/Module Level 2 Record (3.05.1.4)
Function Name – 3.05.1.4 Create/update UTA/module Level 2 record
Description – Creates new records or updates UTA/module Level 2 records.
Object Type – Submission Manager – Activity
Action Type – Update
Field List – sf_Subject;;sf_Type ID;;sf_Status ID;;sf_Owner ID;;sf_Start Date;;sf_End Date;;sf_Parent ID;;cf_Payment Notes
Sample 1G – Add a new UTA/module Level 2 record.
Mandatory fields to add a new record:
recordid: set to "0" to create a new record
sf_Parent ID: parent of the Level 2 record; use objectid in place of sf_Parent ID to update
sf_Type ID: assigned Type ID of the new Level 2 record
sf_Status ID: assigned Status ID of the new Level 2 record
--Begin custom parameter--
jsonrset : [{"recordid":"0","objectid":"10697883","sf_Type ID":"49096",
"sf_Status ID":"49093","sf_Start Date":"2018-10-01",
"sf_End Date":"2018-11-01","cf_Payment Notes":"new record added as an example"}]
--End custom parameter--
Sample 1H – Update an existing UTA/module Level 2 record.
Mandatory fields to update a custom field of an existing record:
recordid: the Event ID of the existing record
--Begin custom parameter--
jsonrset : [{"recordid":"10020959","cf_Payment Notes":"Change value of this custom field thru API function"}]
--End custom parameter--
Update Multiple Addresses of an Organization (3.05.2.1)
Function Name – 3.05.2.1 Update Multiple Addresses Method Sample 1: update addresses of an existing Organization
Description – Creates new records or updates existing multiple addresses of an existing organization.
Object Type – Company
Action Type – Multiple Addresses - Update
Field List – sf_Address;;sf_Address 2;;sf_City;;sf_State / Province;;sf_Country;;sf_Zip / Postal Code;;sf_Primary Address;;sf_Type;;sf_Type ID;;sf_Updated By;;sf_Last Modified;;sf_Object ID
Sample 2A – Create a new multiple address for an existing company.
Mandatory fields to add a new record:
recordid: set to "0" to create a new record
sf_Object ID: the Company ID where the address will be attached
sf_Type ID: the multiple address type
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"1688407","sf_Type ID":"74117",
"sf_Address":"2018 Yonge Street","sf_Country":"10",
"sf_Address 2":"Suite 401111","sf_City":"Toronto","sf_State / Province":"ON"}]
--End custom parameter--
Sample 2B – Update an existing multiple address record.
Mandatory fields to update records:
recordid: the unique identifier from the Association table
--Begin custom parameter--
jsonrset : [{"recordid":"632573","sf_Address":"New Street Address","sf_City":"New City"}]
--End custom parameter--
Update Contact Associations of a Level 1 (3.05.3.1)
The Associations - Update function can add new association records or update the role of an existing association record.
To add a new record, the following parameters are mandatory: objectid, companyid or contactid, rolename or roleid.
To update an existing association record, it can only update the role. Mandatory parameters are: objectid, companyid or contactid, rolename or roleid, and associationid. When the existing record is updated to a new role, all custom fields from the previous role are deleted.
To change company or contact, delete the record and add a new association.
Function Name – 3.05.3.1 Update Associations Method Sample 1: update contact associations of an existing Level 1
Description – Creates new records or updates existing contacts associated with an existing Level 1 record.
Object Type – Submission Manager – Grant
Action Type – Update Associations
Field List – contacts.*
Sample 3A – Create a new user association with an existing Submission Manager Level 1.
Mandatory fields:
objectid: Opportunity ID where the user will be associated
contactid: User ID
rolename / roleid: association role of the user
isupdate: "1" to update; "0" to add a new record
Parameter Sample 1:
--Begin custom parameter--
jsonrset : [{"recordid":"10697883","contacts":[{"contactid":"3108577","rolename":"Meeting Participant","isupdate":"0"}]}]
--End custom parameter--
Parameter Sample 2:
--Begin custom parameter--
jsonrset : [{"recordid":"10697883","contacts":[{"contactid":"3108577","rolename":"Signee Internal"}]}]
--End custom parameter--
Parameter Sample 3 – Adding multiple contacts:
--Begin custom parameter--
jsonrset : [{"recordid":"10697883","contacts":[{"contactid":"3108226","rolename":"Signee Internal"},
{"contactid":"3108119","rolename":"Meeting Participant"}]}]
--End custom parameter--
Sample 3B – Update association information of an existing Submission Manager Level 1 record.
Mandatory fields:
objectid: Opportunity ID where the user will be associated
isupdate: "1" for yes; "0" for no
contactid: User ID
associationid: the unique numerical value for the Association record
rolename / roleid: Role ID
--Begin custom parameter--
jsonrset : [{"recordid":"10697883","contacts":[{"isupdate":"1","contactid":"88435720",
"associationid":"2829620","rolename":"Signee Internal","cf_My customfield":"updated value"}]}]
--End custom parameter--
Update a System Variable (3.05.4.1)
Function Name – 3.05.4.1 System Variables Sample 1: Update
Description – Updates the value or the name of an existing system variable.
Object Type – System Variables
Action Type – Update
Field List – sf_ID;;sf_Name;;sf_Value
--Begin custom parameter--
jsonrset : [{"recordid":"9313","sf_Value":"2"}]
--End custom parameter--
Upload and Download File
Download Files from a Company Profile (3.06.1)
Function Name – 3.06.1 Download File Method Sample 1: Download file(s) from an existing company record
Description – Downloads a file based on the criteria indicated.
Object Type – Company
Action Type – Files - Download
Mandatory fields to download a file:
filename: name of the file to be downloaded
objectid: the Company ID where the file is attached
fieldid: Custom Field ID of the organization record that is either a single file type or multiple file type
--Begin custom parameter--
filename : Test.txt
objectid : 1688407
fieldid : 1523157
--End custom parameter--
Upload Files to a Field in the Company Profile (3.06.2)
Function Name – 3.06.2 Upload File Method Sample 1: Upload file(s) to an existing company record
Description – Uploads a file based on the criteria indicated.
Object Type – Company
Action Type – Files - Upload
Field List – cf_123456
Mandatory fields to upload a file:
objectid: the Company ID where the file is attached
fieldid: Custom Field ID of the organization record that is either a single file type or multiple file type
--Begin custom parameter--
objectid : 1688407
fieldid : 1523157
--End custom parameter--
Search File
Use the Search Files action type to retrieve a list of files by searching for a keyword.
Search Case Documents (3.07.1)
Function Name – 3.07.1 Search Files Method Sample 1: Search Case Documents
Description – Searches a multiple file field for a keyword.
Object Type – Case Management 360° – Case
Action Type – Files - Search
Field List – cf_Case Documents;;sf_Application Template Type;;sf_Customer
--Begin custom parameter--
keywords: HIPAA
--End custom parameter--
Delete
Use the Delete action type to delete existing records.
Delete a Single Organization Record (3.08.1)
Function Name – 3.08.1 Delete Organization Record
Description – Deletes an existing organization record.
Object Type – Company
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"1924628"}]
--End custom parameter--
Delete a Single Contact Record (3.08.2)
Function Name – 3.08.2 Delete Contact Record
Description – Deletes an existing user record.
Object Type – User
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"88173129"}]
--End custom parameter--
Delete Organization Records – Batch Delete (3.08.3)
Function Name – 3.08.3 Delete Organization Records
Description – Deletes multiple existing organization records.
Object Type – Company
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"1924629"},{"recordid":"1924630"},{"recordid":"1924631"}]
--End custom parameter--
Result:
{"records":[{"recordid":"1924629","status":"Object Deleted"},
{"recordid":"1924630","status":"Object Deleted"},
{"recordid":"1924631","status":"Object Deleted"}],"message":{}}
Delete a Single Grant Application Record (3.08.4)
Function Name – 3.08.4 Delete UTA/module Level 1 Record
Description – Deletes an existing UTA/module Level 1 record.
Object Type – Submission Manager – Grant
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"8276165"}]
--End custom parameter--
Delete a Single Grant Application Payment Record (3.08.5)
Function Name – 3.08.5 Delete UTA/module Level 2 Record
Description – Deletes an existing UTA/module Level 2 record.
Object Type – Submission Manager – Activity
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"10021111"}]
--End custom parameter--
Delete an Association Record (3.08.6)
Function Name – 3.08.6 Delete Association Records
Description – Deletes an existing contact associated with an existing Level 1 record.
Object Type – Submission Manager – Grant
Action Type – Associations - Update
Field List – contacts.*
Mandatory fields:
objectid: Universal Tracking Application Level 1 ID where the user is associated
isdelete: "1" to delete
rolename / roleid: association role of the user
contactid: User ID
associationid: the unique numerical value for the Association record
--Begin custom parameter--
jsonrset : {"objectid":"10697883","contacts":[{"isdelete":"1","contactid":"3108991",
"rolename":"Meeting Participant","associationid":"2829623"}]}
--End custom parameter--
Delete Multiple Upload Files (3.08.7)
After the July 2023 upgrade, a new function was added to delete files from Upload – Multiple Files Storage fields.
Function Name – 3.08.7 Delete Files in Level One
Description – Deletes existing files from a multiple file field in a Level 1 record.
Object Type – Submission Manager – Grant
Action Type – Files – Delete
Field List – cf_multiplefilefield
Mandatory fields:
objectid: Universal Tracking Application Level 1 ID (opportunityid) where the file to be deleted is located
fieldid: the field ID of the multiple file field
filename: the filename of the file to be deleted
--Begin custom parameter--
jsonrset : [{"objectid":"1223454","fieldid":"3163245","filename":"147807_dup.png"},
{"objectid":"1223454","fieldid":"2697568","filename":"128895.png"}]
--End custom parameter--
Variables Replace
Use the Variables Replace action type to pass objectid and a content block of text through the variable processor and return the results as JSON.
Variables Replace – Company (3.09.1)
Function Name – 3.09.1 System Variables Replace – Company
Description – Sends the objectid (Company ID) and desired content with system variables. Returns a JSON format of the content with all system variables replaced by the variable processor.
Object Type – Company
Action Type – Variables Replace
--Begin custom parameter--
objectid : 825646
content : Company name is @name@, located at @address@, @city@, @country@. Primary Contact is @primarycontact@.
--End custom parameter--
Variables Replace – User (3.09.2)
Function Name – 3.09.2 System Variables Replace – User
Description – Sends the objectid (User ID) and desired content with system variables. Returns a JSON format of the content with all system variables replaced by the variable processor.
Object Type – User
Action Type – Variables Replace
--Begin custom parameter--
objectid : 88159402
content : Hello @firstname@ (@userid@), from company @company@, located in @company.address@.
--End custom parameter--
Variables Replace – UTA/Module Level 1 (3.09.3)
Function Name – 3.09.3 System Variables Replace – UTA/Module L1
Description – Sends the objectid (Opportunity ID) and desired content with system variables. Returns a JSON format of the content with all system variables replaced by the variable processor.
Object Type – Submission Manager – Grant
Action Type – Variables Replace
--Begin custom parameter--
objectid : 8276165
content : This application is called "@name@", under the status of "@status@". The owner on this record is "@owner.fullname@", belonging to "@owner.company.name@". The company is "@client.name@". Parent Company is "@company.parent.name@".
--End custom parameter--
Variables Replace – UTA/Module Level 2 (3.09.4)
Function Name – 3.09.4 System Variables Replace – UTA/Module Level 2
Description – Sends the objectid (Event ID) and desired content with system variables. Returns a JSON format of the content with all system variables replaced by the variable processor.
Object Type – Submission Manager – Grant
Action Type – Variables Replace
--Begin custom parameter--
objectid : 18431901
content : This is a level two id record with eventid of "@eventid@" with L2 Type of "@type@" and status of "@status@". The parent record id is "@parent.opportunityid@". The parent Company's address is "@parent.company.address@".
--End custom parameter--
Variables Replace – UTA/Module Level 3 (3.09.5)
Function Name – 3.09.5 System Variables Replace – UTA/module Level 3
Description – Sends the objectid (Event ID) and desired content with system variables. Returns a JSON format of the content with all system variables replaced by the variable processor.
Object Type – Submission Manager – Disbursement
Action Type – Variables Replace
--Begin custom parameter--
objectid : 18432872
content : This is L3 record id "@eventid@", of status "@status@". The parent L2 Type is "@parent.type@". The L1 company is "@parent.parent.company.name@".
--End custom parameter--
Transaction
Transaction must be configured before using this API function. Transactions can be attached to an object (Organization, User, or UTA/module Level 1/Level 2).
Get a Transaction Record from an Organization (3.10.1.1)
Function Name – 3.10.1.1 Get a Transaction Record from an Organization
Description – Retrieves an organization transaction record.
Object Type – Company Transactions
Action Type – Get
Field List – sf_Transaction ID;;sf_Object ID;;sf_Description;;sf_Subject;;sf_Type;;sf_Status;;sf_Created Date;;sf_Modified Date;;sf_Created By;;sf_Updated By
Mandatory fields:
recordid: the unique identifier from the transaction table
--Begin custom parameter--
recordid : 2738520
othersettings :
--End custom parameter--
Retrieve a Transaction Record from a Submission Manager Level 1 (3.10.1.2)
Function Name – 3.10.1.2 Get Method Sample 4: Retrieve a Transaction Record from a Submission Manager Level 1
Description – Retrieves a transaction record from a Submission Manager Level 1.
Object Type – Submission Manager – Transactions
Action Type – Get
Field List – sf_End Date;;sf_Description;;sf_Subject;;sf_Start Date;;sf_Status;;sf_Modified Date;;sf_Updated By;;sf_Created Date;;sf_Created By;;sf_Type;;sf_Transaction ID;;sf_Object ID
Mandatory fields:
recordid: the unique identifier from the transaction table
--Begin custom parameter--
recordid : 2738527
othersettings :
--End custom parameter--
List Transaction Records (3.10.2)
Function Name – 3.10.2 List Transaction Records
Description – Retrieves a list of all transaction records.
Object Type – Submission Manager – Transactions
Action Type – List
Field List – sf_End Date;;sf_Description;;sf_Subject;;sf_Start Date;;sf_Status;;sf_Modified Date;;sf_Updated By;;sf_Created Date;;sf_Created By;;sf_Type;;sf_Transaction ID;;sf_Object ID
Sample 2A – Retrieve all transaction records.
--Begin custom parameter--
criteria :
sortby :
othersettings :
--End custom parameter--
Sample 2B – Retrieve transaction records filtered by Transaction Type.
--Begin custom parameter--
criteria : [{"andor":"and","field":"sf_Type","operator":"=","value":"Transaction_in_Org"}]
sortby :
othersettings :
--End custom parameter--
Create or Update a Transaction Record in an Organization Profile (3.10.3.1)
Function Name – 3.10.3.1 Create or Update Transaction Record in Organization Profile
Description – Creates a new transaction record attached to an organization record.
Object Type – Company Transactions
Action Type – Update
Field List – sf_Transaction ID;;sf_Object ID;;sf_Description;;sf_Subject;;sf_Type;;sf_Status;;sf_Created Date;;sf_Modified Date;;sf_Created By;;sf_Updated By
Mandatory fields to add a new transaction record:
recordid: set to "0" to create a new record
sf_Object ID: the object (Organization, User, or UTA/module Level 1/Level 2) the transaction is attached to
sf_Type: Transaction Type of the transaction record
sf_Status: Transaction Status of the transaction record
Sample 3A – Create a new transaction record.
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"10697883","sf_Type":"2184","sf_Status":"82626","sf_Subject":"Test Transaction Record"}]
--End custom parameter--
Sample 3B – Update an existing transaction record.
--Begin custom parameter--
jsonrset : [{"recordid":"2738520","sf_Subject":"Changed subject thru api"}]
--End custom parameter--
Create or Update a Transaction Record in Submission Manager Level 1 (3.10.3.2)
Function Name – 3.10.3.2 Create or Update Transaction Record in Submission Manager L1
Description – Creates a new transaction record attached to a Submission Manager Level 1 record.
Object Type – Submission Manager – Transactions
Action Type – Update
Field List – sf_Object ID;;sf_Subject;;sf_Status;;sf_Type
Mandatory fields to add a new transaction record:
recordid: set to "0" to create a new record
sf_Object ID: the object (UTA/module Level 1 or Level 2) the transaction is attached to
sf_Type: Transaction Type of the transaction record
sf_Status: Transaction Status of the transaction record
Sample A – API v1:
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"10697883","sf_Type":"2184","sf_Status":"82626","sf_Subject":"Test Transaction Record"}]
--End custom parameter--
Sample B – API v2 (UTA/module Level 1): The translevel parameter is available in API v2 only. Use translevel=1 for UTA/module Level 1 and translevel=2 for UTA/module Level 2.
Additional mandatory field for API v2:
translevel: the UTA/module level the transaction is attached to (1 for Level 1, 2 for Level 2)
API v2 Field List: sf_Object ID;;sf_Subject;;sf_Status;;sf_Type;;cf_Remarks
API v2 Endpoint: /API/2/transactions/
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"10697883","sf_Type":"2119","sf_Status":"82626","translevel":"1","sf_Subject":"Test Transaction Record"}]
--End custom parameter--
Sample C – API v2 (UTA/module Level 2):
API v2 Field List: sf_Object ID;;sf_Subject;;sf_Status;;sf_Type;;cf_Remarks
API v2 Endpoint: /API/2/transactions/
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"10697974","sf_Type":"2184","sf_Status":"82626","sf_Subject":"Test Transaction Record","translevel":"2"}]
--End custom parameter--
Delete a Transaction Record (3.10.4)
Function Name – 3.10.4 Delete Transaction Record
Description – Deletes a transaction record.
Object Type – Company Transactions
Action Type – Delete
--Begin custom parameter--
jsonrset : [{"recordid":"2738523"}]
--End custom parameter--
Link and Unlink Transaction Records (3.10.5)
This function is available in API v2 only and applies to Level 1 and Level 2 transactions.
API v2 Endpoint: /API/2/transactions/
Sample A – Link an existing transaction to a Level 1 record.
Function Name – Link transaction record to an existing Submission Manager L1
Description – Links an existing company transaction record to an existing Submission Manager Level 1 record.
Object Type – Submission Manager – Transactions
Action Type – Link / Unlink
Field List – cf_5469887
Mandatory fields:
sf_Object ID: UTA/module Level 1 ID the transaction is attached to
translevel: level in the UTA/module to link the transaction to
sf_transaction id: existing transaction record ID
islink: indicates to link the transaction to a record
cf_5469887: transaction custom field
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"1123456","translevel":"1","cf_5469887":"Test linking Transaction to SML1","sf_transaction id":"6165326","islink":"1"}]
--End custom parameter--
Sample B – Unlink an existing transaction from a Level 1 record.
Mandatory fields:
sf_Object ID: UTA/module Level 1 ID
translevel: level in the UTA/module
sf_transaction id: existing transaction record ID
unlink: indicates to unlink the transaction from the record
--Begin custom parameter--
jsonrset : [{"sf_Object ID":"1123456","translevel":"1","sf_transaction id":"6165326","unlink":"1"}]
--End custom parameter--
Sample C – Link an existing transaction to a Level 2 record.
Object Type – Submission Manager – Transactions
Action Type – Link / Unlink
Field List – cf_5469887
Mandatory fields:
sf_Object ID: UTA/module Level 2 ID
translevel: level in the UTA/module
sf_transaction id: existing transaction record ID
islink: indicates to link the transaction to a record
cf_5469887: transaction custom field
--Begin custom parameter--
jsonrset : [{"recordid":"0","sf_Object ID":"50268865","translevel":"2","cf_5469887":"Test linking Transaction to SML2","sf_transaction id":"6165326","islink":"1"}]
--End custom parameter--
Sample D – Unlink an existing transaction from a Level 2 record.
Mandatory fields:
sf_Object ID: UTA/module Level 2 ID
translevel: level in the UTA/module
sf_transaction id: existing transaction record ID
unlink: indicates to unlink the transaction from the record
--Begin custom parameter--
jsonrset : [{"sf_Object ID":"50268865","translevel":"2","sf_transaction id":"6165326","unlink":"1"}]
--End custom parameter--
UTA/Module Consumer/Provider
Consumer/Provider relationships must be configured before using this API function. UTA/module Provider/Consumer Relationships allow for the sharing of data between different Universal Tracking Applications (UTAs).
- The add/update function does not support custom fields of the relationship.
- The update function is only used to update the role between consumer and provider. When roleid or rolename is updated, all custom fields of the relationship from the previous role are deleted.
- To update either the consumerid or the providerid, delete the record first and then add a new consumer/provider record.
- The List function supports standard fields and custom fields of the relationship.
List Consumer/Provider Records (3.11.1)
Function Name – 3.11.1 List Consumer/Provider Records
Description – Retrieves a list of all Consumer/Provider records.
Object Type – Submission Manager – Grant
Action Type – Provider/Consumer - List
Provider/Consumer Link – Meeting Manager – L1 to Submission Manager – L1
Sample 1A – Retrieve all consumer/provider records.
--Begin custom parameter--
criteria :
sortby :
othersettings :
--End custom parameter--
Create, Update, or Delete Consumer/Provider Records (3.11.2)
Function Name – 3.11.2 Create or Update or Delete Consumer/Provider Records
Description – Creates, updates, or deletes consumer/provider records.
Object Type – Submission Manager – Grant
Action Type – Provider/Consumer - Update
Provider/Consumer Link – Meeting Manager – L1 to Submission Manager – L1
Mandatory fields:
providerid: Application ID of the provider UTA/module
consumerid: Application ID of the consumer UTA/module
roleid / rolename: connection role between consumer and provider
associationid: unique identifier for the consumer/provider relationship table
Sample 2A – Create a new consumer/provider record.
--Begin custom parameter--
jsonrset : [{"associationid":"0","roleid":"82840","consumerid":"10697883","providerid":"11191051"}]
--End custom parameter--
Sample 2B – Update an existing consumer/provider record.
--Begin custom parameter--
jsonrset : [{"associationid":"265692","isupdate":"1","rolename":"Cycle","consumerid":"8276105","providerid":"11190976"}]
--End custom parameter--
Sample 2C – Delete an existing consumer/provider record.
--Begin custom parameter--
jsonrset : [{"associationid":"265694","isdelete":"1","rolename":"Meeting","consumerid":"8276202","providerid":"11190976"}]
--End custom parameter--