Skip to main content
Announcements
Qlik Connect 2024! Seize endless possibilities! LEARN MORE

Salesforce - Generic API blocks

No ratings
cancel
Showing results for 
Search instead for 
Did you mean: 
PradeepUrala
Former Employee
Former Employee

Salesforce - Generic API blocks

Last Update:

Sep 6, 2021 11:17:52 AM

Updated By:

PradeepUrala

Created date:

Sep 6, 2021 11:07:26 AM

The Salesforce connector supports the generic CRUD operations that can be performed on various objects of Salesforce:

  • API LIST Recently Deleted Records Incrementally:
    The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. This Incremental blocks initially get a complete list of deleted records for no more than 15 days previous to the day the call is executed, this can then be scheduled to periodically poll the API to get records that have been deleted since the previous poll. The records are fetched from a delete log resource from the Salesforce application.
    Please Note, A Salesforce background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the number of records is above a certain limit. Starting with the oldest records, the process purges delete log entries until the delete log is back below the limit.
    recentlyDeleted_1.PNG

     

  • API LIST Recently Created and Updated Records Incrementally:
    The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. This Incremental blocks initially get a complete list of newly created and updated records for no more than 30 days previous to the day the call is executed, this can then be scheduled to periodically poll the API to get records that have been created or updated since the previous poll. There is a limit of 600,000 IDs returned from this resource. If more than 600,000 IDs would be returned, EXCEEDED_ID_LIMIT is returned.

  • API LIST Records Incrementally:
    This Incremental blocks initially get a complete list of newly created, updated, and deleted records, this can then be scheduled to periodically poll the API to get records that have been created, updated, and deleted since the previous poll. The 'Operation' parameter allows selecting the type of query that needs to be run. The 'query' operation is used to fetch only newly created and updated records, Whereas, the 'queryAll' operation can be used to fetch The newly created, updated, and deleted records.
    The 'Fields' parameter accepts the field names to be present in the response. The 'List Fields From Object' can be used to list out all the available fields for an object.

  • API GET Record By Id:
    The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. This block gets the complete data of a record. You can use the 'Extra fields' parameter to specify the exact fields to be retrieved rather than retrieving the entire fields of a record.
    getById_1.PNG

     

  • API GET Record By External Id:
    The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. 'External Field' is the parameter that accepts the field name of the External ID while the 'ID' field holds the ID of this field. You can use the 'do lookup' option to list out all the available fields. This block gets the complete data of a record. You can use the 'Extra fields' parameter to specify the exact fields to be retrieved rather than retrieving the entire fields of a record.
    getByExternalID.PNG

     

  • API CREATE Record:
    The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. Once the Object is selected the available fields for these objects are loaded and can be filled out by adding items. You can also add the plain JSON object by toggling to the raw input (as shown in the Screenshot).
    Choosing fieldsChoosing fieldsRaw JSON inputRaw JSON input


  • API UPDATE Record:
    This block updates a record based on its ID. The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. Once the Object is selected the available fields for these objects are loaded and can be filled out by adding items. You can also add the plain JSON object by toggling to the raw input.

  • API UPSERT Record By External ID:
    This block updates the record based on the given data if the specified External ID is found in the system, else it Creates a new record. The 'do lookup' option lists out all the available objects to choose from to perform a particular API call. Once the Object is selected the available fields for these objects are loaded and can be filled out by adding items. You can also add the plain JSON object by toggling to the raw input.

  • Custom Query:
    This block can be used as a List or Search block to list out all the records of a specific object. Any basic queries like "SELECT id,email FROM Contact" to list All Contacts or queries like "SELECT id,name FROM Contact WHERE email = 'john.doe@mail.com'" to search All Contacts with email ID 'john.doe@mail.com' can be executed using this query.

  • Custom Query (All):
    This block can also be used as a List or Search block to list out all the records of a specific object. The main difference of this block with respect to the 'Custom Query' block is that it can as well list out deleted records of a particular object.
    CustomQueryAll.PNG

     

Tags (1)
Labels (1)
Contributors
Version history
Last update:
‎2021-09-06 11:17 AM
Updated by: