Tip of the week # 215 : Salesforce REST API



Salesforce REST API's with Examples

Description : Salesforce REST API allows external applications to interact with Salesforce using HTTP methods like GET, POST, PATCH, and DELETE. It streamlines CRUD operations, making integrations simpler and more efficient.
Types of Salesforce REST API's :

  • Standard REST API : For basic record operations. (Below example for create account via REST API)

    
    
     Method:- Post
     URL:- /services/data/v36.0/sobjects/Account/
     Request Body :-<br>
     {  
      "Name" : "Account from Rest API",  
      "phone" : "1111111111",  
      "website" : "www.salesforce1.com",  
      "numberOfEmployees" : "100",  
      "industry" : "Banking"
      }
      Response Body :-<br>
      {
          "id" : "00190000001pPvHAAU",
          "errors" : [ ],
          "success" : true,
          "created": true
      }
    Note : You have to add all object based required field like Account has Name, Contact has Last Name etc

  • Composite API: To execute multiple REST API requests within a single call.(Below example for create account with Contact via REST API)

    
    
    	Method:- Post
        URL:- /services/data/v36.0/sobjects/Account/
        Request Body :-<br>
		{
        "compositeRequest" : [{
          "method" : "POST",
          "url" : "/services/data/v64.0/sobjects/Account",
          "referenceId" : "refAccount",
          "body" : { "Name" : "Sample Account" }
          },{
          "method" : "POST",
          "url" : "/services/data/v64.0/sobjects/Contact",
          "referenceId" : "refContact",
          "body" : { 
            "LastName" : "Sample Contact",
            "AccountId" : "@{refAccount.id}"
            }
          }]
        }
        Response Body :-<br>
        {
          "compositeResponse": [
            {
              "body": {
                "id": "0015g00000ABCD1AAL",
                "success": true,
                "errors": []
              },
              "httpHeaders": {},
              "httpStatusCode": 201,
              "referenceId": "newAccount"
            },
            {
              "body": {
                "id": "0035g00000XYZ12AAH",
                "success": true,
                "errors": []
              },
              "httpHeaders": {},
              "httpStatusCode": 201,
              "referenceId": "newContact"
            }
          ]
        }
    Note : Its also support partial insertion with "allOrNone": true param is body.
    Type :
    Composite SObjects: Inserts multiple records of potentially different sObject types in a single request.
    Composite Tree: Inserts a parent record and its related child records in a single request, maintaining the parent-child relationship.

  • Bulk API:Designed for efficiently processing large data volumes in an asynchronous manner.

    
    
		Method:- Post
        URL:- /services/data/v64.0/jobs/ingest/<br>
        CSV File Name : bulkinsert.csv (With CSV file with header as field API name of Object)
        File : newinsertjob.json :-<br>
        {
            "object" : "Account",
            "contentType" : "CSV",
            "operation" : "insert",
            "lineEnding" : "LF"
        }
        Response Body :-<br>
        { "id" : "7505fEXAMPLE4C2AAM",
        "operation" : "insert",
        "object" : "Account",
        "createdById" : "0055fEXAMPLEtG4AAM",
        "createdDate" : "2022-01-02T21:33:43.000+0000",
        "systemModstamp" : "2022-01-02T21:33:43.000+0000",
        "state" : "Open",
        "concurrencyMode" : "Parallel",
        "contentType" : "CSV",
        "apiVersion" : 64.0,
        "contentUrl" : "services/data/64.0/jobs/ingest/7505fEXAMPLE4C2AAM/batches",
        "lineEnding" : "LF","columnDelimiter" : "COMMA" 
        }
  • Note : you can monitor the job with below REST API /services/data/v64.0/jobs/ingest/7505fEXAMPLE4C2AAM(Job Id)/successfulResults/

Happy Sharing...

Everyone has their own favorites, so please feel free to share with yours contacts and comments below for any type of help!

Use below Chrome Extension for Productivity and share your feedback. Download Link : https://chromewebstore.google.com/detail/quick-shortcuts/ldodfklenhficdgllchmlcldbpeidifp?utm_source=ext_app_menu

Comments

Post a Comment

Popular posts from this blog

User Data Privacy

User Data Privacy User Data Privacy Our Chrome extension does not collect any personal data or user information. We are committed to respecting your privacy and ensuring a secure browsing experience. You can use our extension with confidence, knowing that your data remains private and secure. If you have any concerns or questions regarding privacy or data security, please feel free to contact us at sanjayibirds2013@gmail.com .
Read more

Salesforce LWC : Compact Layout on Hover

Image
Salesforce LWC : Compact Layout showing on Hover Sometime we have requirement to show Account name link on standard views, a popup with the Compact Layout shows the details of that record. LWC Parent Component : Template (HTML Code) LWC : JS (Process Code) import { LightningElement,api } from 'lwc'; export default class AccountComponent extends LightningElement { @api recordId; @track objRecordId; handleMouseover(event) { console.log(this.recordId); this.objRecordId = null const toolTipDiv = this.template.querySelector('div.ModelTooltip'); toolTipDiv.style.opacity = 1; toolTipDiv.style.display = "block"; // eslint-disable-next-line window.clearTimeout(this.delayTimeout); // esli...
Read more

Salesforce : Multi-Factor Authentication

Image
Salesforce : Multi-Factor Authentication Evidence that users provide when logging in to confirm their identity.. One factor is something users know. For Salesforce logins, with user credeantial Two factors are verification methods that a user has in their possession, such as a mobile device with an authenticator app installed or a physical security key. How Multi-Factor Authentication Works 1. A user enters their username and password, as usual. 2. A user is prompted to provide one of the verification methods that Salesforce supports.. Salesforce verification methods: Salesforce Authenticator : A free mobile app that integrates seamlessly into your login process from Salesforce Third-party authenticator apps : This code is sometimes called a time-based one-time password, or TOTP for short. Users can pick from a wide variety of options, including Google Authenticator, Microsoft Authenticator, or Authy. Security keys : Small physical tokens that look like...
Read more