How to run Apex REST API Post/Put/Patch/Get/Delete through Workbench into Opportunity object in Salesforce | Steps to call apex rest service Post/Put/Patch/Get/Delete from workbench rest explorer in Salesforce | How to make call to apex rest api in Workbench in Salesforce

889 views

Hey guys, today in this post we are going to learn about How to run Apex REST API Post/Put/Patch/Get/Delete through Workbench into Opportunity object in Salesforce.

A REST resource is an abstraction of a piece of information or an action, such as a single data record, a collection of records, or a query. Each resource in REST API is identified by a named Uniform Resource Identifier (URI) and is accessed using standard HTTP methods (HEAD, GET, POST, PATCH, DELETE). REST API is based on the usage of resources, their URIs, and the links between them. To know more details about Apex Rest API, Click Here.

Final Output →

Download ebooks:- Click here to download E-Book "The most 20 popular articles of w3web.net"

Method:- GET (Opportunity Record)

    @httpGet
    global static Opportunity getOpportunityById(){
         RestRequest request = RestContext.request;
         RestResponse response  = RestContext.response;
        //grab the oppId from the end of the URL       
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
        Opportunity result = [Select Id, Name, LeadSource, Closedate, Probability From Opportunity Where Id =:oppId];
        return result;
    }

@httpGet

global static Opportunity getOpportunityById(){

RestRequest request = RestContext.request;

RestResponse response = RestContext.response;

//grab the oppId from the end of the URL

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Opportunity result = [Select Id, Name, LeadSource, Closedate, Probability From Opportunity Where Id =:oppId];

return result;

}

call apex rest service from workbench rest explorer -- w3web.net

Method:- Post (Opportunity Record)

   @httpPost
    global static ID createOpportunity(String name, String stage, string closeDate, string source){
        Opportunity newOpp = new Opportunity(
             name=name,
             stageName=stage,
             leadSource=source,
             closeDate=date.valueOf(closeDate)
        );
        insert newOpp;
        return newOpp.Id;
    }

@httpPost

global static ID createOpportunity(String name, String stage, string closeDate, string source){

Opportunity newOpp = new Opportunity(

name=name,

stageName=stage,

leadSource=source,

closeDate=date.valueOf(closeDate)

);

insert newOpp;

return newOpp.Id;

}

Method:- Post with (Convert PDF to Base64, Send Attachment to Salesforce)

    //Convert PDF to Base64:-https://base64.guru/converter/encode/pdf
    @httpPost
    global static ID createOpportunity(String name, String stage, string closeDate, string source, string attachfilestr, string blobStr){
         Opportunity newOpp = new Opportunity();
         newOpp.Name=name;
         newOpp.stageName=stage;
         newOpp.leadSource=source;
         newOpp.closeDate=date.valueOf(closeDate);
         insert newOpp;
        
        ContentVersion fileContentObj = new ContentVersion();
         fileContentObj.ContentLocation = 'S'; 
         fileContentObj.PathOnClient = attachfilestr;
         fileContentObj.Title = attachfilestr;
         fileContentObj.VersionData = EncodingUtil.base64Decode(blobStr);  
         fileContentObj.FirstPublishLocationId  = newOpp.Id;
         insert fileContentObj;
        
        return newOpp.Id;
    }

//Convert PDF to Base64:-https://base64.guru/converter/encode/pdf

@httpPost

global static ID createOpportunity(String name, String stage, string closeDate, string source, string attachfilestr, string blobStr){

Opportunity newOpp = new Opportunity();

newOpp.Name=name;

newOpp.stageName=stage;

newOpp.leadSource=source;

newOpp.closeDate=date.valueOf(closeDate);

insert newOpp;

ContentVersion fileContentObj = new ContentVersion();

fileContentObj.ContentLocation = 'S';

fileContentObj.PathOnClient = attachfilestr;

fileContentObj.Title = attachfilestr;

fileContentObj.VersionData = EncodingUtil.base64Decode(blobStr);

fileContentObj.FirstPublishLocationId = newOpp.Id;

insert fileContentObj;

return newOpp.Id;

}

Method:- Put (Opportunity Record)

   @httpPut
    global static ID createOpportunity(String name, String stage, string closeDate, string source, string id){
        Opportunity newOpp = new Opportunity(
             name=name,
             stageName=stage,
             leadSource=source,
             closeDate=date.valueOf(closeDate),
             Id=id
        );
        upsert newOpp;
        return newOpp.Id;
    }

@httpPut

global static ID createOpportunity(String name, String stage, string closeDate, string source, string id){

Opportunity newOpp = new Opportunity(

name=name,

stageName=stage,

leadSource=source,

closeDate=date.valueOf(closeDate),

Id=id

);

upsert newOpp;

return newOpp.Id;

}

Method:- Patch (Opportunity Record)

    @HttpPatch
    global static ID updateOppFlds(){
        RestRequest request = RestContext.request;
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
         Map<String, Object> mapObj = new Map<String, Object>(); 
         Opportunity thisOpportunity = [Select Id From Opportunity Where Id =:oppId];
          Map<String, Object> params = (Map<String, Object>)JSON.deserializeUntyped(request.requestbody.tostring());
      
        for(String fieldName:params.keySet()){
           thisOpportunity.put(fieldName,params.get(fieldName));
        }
    
        update thisOpportunity;
        return thisOpportunity.Id;
    }

@HttpPatch

global static ID updateOppFlds(){

RestRequest request = RestContext.request;

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Map<String, Object> mapObj = new Map<String, Object>();

Opportunity thisOpportunity = [Select Id From Opportunity Where Id =:oppId];

Map<String, Object> params = (Map<String, Object>)JSON.deserializeUntyped(request.requestbody.tostring());

for(String fieldName:params.keySet()){

thisOpportunity.put(fieldName,params.get(fieldName));

}

update thisOpportunity;

return thisOpportunity.Id;

}

Method:- Delete (Opportunity Record)

  @httpDelete    
    global static void deleteOppsRec(){
        RestRequest request = RestContext.request;
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
         Opportunity thisOppRec = [Select Id From Opportunity Where Id =:oppId];
        delete thisOppRec;
    }

@httpDelete

global static void deleteOppsRec(){

RestRequest request = RestContext.request;

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Opportunity thisOppRec = [Select Id From Opportunity Where Id =:oppId];

delete thisOppRec;

}

Find complete code

Create Apex Class : apexRestAPI.apxc

From Developer Console >> File >> New >> Apex Class

apexRestAPI.apxc [Apex Class Controller]

   @RestResource(urlMapping = '/opportunityApexRest/*')
global with sharing class apexRestAPI {
  
    @httpGet
    global static Opportunity getOpportunityById(){
         RestRequest request = RestContext.request;
         RestResponse response  = RestContext.response;
        //grab the oppId from the end of the URL       
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
        Opportunity result = [Select Id, Name, LeadSource, Closedate, Probability From Opportunity Where Id =:oppId];
        return result;
    }
    
    
   //Convert PDF to Base64:-https://base64.guru/converter/encode/pdf
    @httpPost
    global static ID createOpportunity(String name, String stage, string closeDate, string source, string attachfilestr, string blobStr){
         Opportunity newOpp = new Opportunity();
         newOpp.Name=name;
         newOpp.stageName=stage;
         newOpp.leadSource=source;
         newOpp.closeDate=date.valueOf(closeDate);
         insert newOpp;
        
        ContentVersion fileContentObj = new ContentVersion();
         fileContentObj.ContentLocation = 'S'; 
         fileContentObj.PathOnClient = attachfilestr;
         fileContentObj.Title = attachfilestr;
         fileContentObj.VersionData = EncodingUtil.base64Decode(blobStr);  
         fileContentObj.FirstPublishLocationId  = newOpp.Id;
         insert fileContentObj;
        
        return newOpp.Id;
    }
    
    
    @httpPut
    global static ID createOpportunity(String name, String stage, string closeDate, string source, string id){
        Opportunity newOpp = new Opportunity(
             name=name,
             stageName=stage,
             leadSource=source,
             closeDate=date.valueOf(closeDate),
             Id=id
        );
        upsert newOpp;
        return newOpp.Id;
    }
    
    
    
    @HttpPatch
    global static ID updateOppFlds(){
        RestRequest request = RestContext.request;
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
         Map<String, Object> mapObj = new Map<String, Object>(); 
         Opportunity thisOpportunity = [Select Id From Opportunity Where Id =:oppId];
          Map<String, Object> params = (Map<String, Object>)JSON.deserializeUntyped(request.requestbody.tostring());
      
        for(String fieldName:params.keySet()){
           thisOpportunity.put(fieldName,params.get(fieldName));
        }
    
        update thisOpportunity;
        return thisOpportunity.Id;
    }
  
    
   @httpDelete    
    global static void deleteOppsRec(){
        RestRequest request = RestContext.request;
         String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);
         Opportunity thisOppRec = [Select Id From Opportunity Where Id =:oppId];
        delete thisOppRec;
        
    
    
}

@RestResource(urlMapping = '/opportunityApexRest/*')

global with sharing class apexRestAPI {

@httpGet

global static Opportunity getOpportunityById(){

RestRequest request = RestContext.request;

RestResponse response = RestContext.response;

//grab the oppId from the end of the URL

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Opportunity result = [Select Id, Name, LeadSource, Closedate, Probability From Opportunity Where Id =:oppId];

return result;

}

//Convert PDF to Base64:-https://base64.guru/converter/encode/pdf

@httpPost

global static ID createOpportunity(String name, String stage, string closeDate, string source, string attachfilestr, string blobStr){

Opportunity newOpp = new Opportunity();

newOpp.Name=name;

newOpp.stageName=stage;

newOpp.leadSource=source;

newOpp.closeDate=date.valueOf(closeDate);

insert newOpp;

ContentVersion fileContentObj = new ContentVersion();

fileContentObj.ContentLocation = 'S';

fileContentObj.PathOnClient = attachfilestr;

fileContentObj.Title = attachfilestr;

fileContentObj.VersionData = EncodingUtil.base64Decode(blobStr);

fileContentObj.FirstPublishLocationId = newOpp.Id;

insert fileContentObj;

return newOpp.Id;

}

@httpPut

global static ID createOpportunity(String name, String stage, string closeDate, string source, string id){

Opportunity newOpp = new Opportunity(

name=name,

stageName=stage,

leadSource=source,

closeDate=date.valueOf(closeDate),

Id=id

);

upsert newOpp;

return newOpp.Id;

}

@HttpPatch

global static ID updateOppFlds(){

RestRequest request = RestContext.request;

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Map<String, Object> mapObj = new Map<String, Object>();

Opportunity thisOpportunity = [Select Id From Opportunity Where Id =:oppId];

Map<String, Object> params = (Map<String, Object>)JSON.deserializeUntyped(request.requestbody.tostring());

for(String fieldName:params.keySet()){

thisOpportunity.put(fieldName,params.get(fieldName));

}

update thisOpportunity;

return thisOpportunity.Id;

}

@httpDelete

global static void deleteOppsRec(){

RestRequest request = RestContext.request;

String oppId = request.requestURI.substring(request.requestURI.lastIndexOf('/')+1);

Opportunity thisOppRec = [Select Id From Opportunity Where Id =:oppId];

delete thisOppRec;

}

TechW3web:- To know more, Use this Link – YouTube

FAQ (Frequently Asked Questions)

How do I call a custom REST API from workbench?

Choose the GET method in the workbench. Enter the custom API in the URL. Add the Case id as a parameter and hit the “Execute” button. This will execute the Get method within the Salesforce apex class.

What is the difference between REST API and Apex REST API?

The REST API (Force.com REST API) is the generic API provided by Salesforce. On the other hand, the Apex REST API is an API written by yourself in apex to provide custom methods.

How do I run apex in workbench?

Navigate to Utilities à Apex Execute. Enter the Apex Code in the provided space, that work as an Anonymous window. Select the 'Log category' as 'Apex Code' and 'Log Level' as 'Debug'. Click the 'Execute' button to see the results of the Apex Execution in the same window.

Author of w3web.net

Hi, This is Vijay Kumar behind the admin and founder of w3web.net. I am a senior software developer and working in MNC company from more than 8 years. I am great fan of technology, configuration, customization & development. Apart of this, I love to write about Blogging in spare time, Working on Mobile & Web application development, Salesforce lightning, Salesforce LWC and Salesforce Integration development in full time. [Read full bio] | | The Sitemap where you can find all published post on w3web.net