Salesforce Rest API

Salesforce Rest Api



Šajā rokasgrāmatā mēs apspriedīsim, kā ievietot ierakstus programmā Salesforce, izmantojot REST API, izmantojot POST un PUT http metodes programmā Workbench. Šīs rokasgrāmatas ietvaros mēs apspriedīsim, kā izmantot Workbench un iegūt konkrētus ierakstus, izmantojot sObject, iegūt vairākus ierakstus no objekta, izmantojot vaicājumu, un izgūt ierakstus, rakstot Apex pielāgoto REST API.

POST metode

POST ir http metode, kas Salesforce pievieno vienu/vairākus ierakstus vienlaikus. Mēs varam ievietot ierakstus ar URI, izmantojot pielāgoto Apex REST API vai tieši no URI.

Pielāgots atpūtas resurss Apex

Lai Apex rakstītu REST, mums ir jāizmanto dažas anotācijas, kas jūsu Apex klasē piekļūst REST API.







@HttpPost anotācija

Šī metode tiek izsaukta, kad tiek nosūtīts HTTP POST, kas nodrošina Apex metodi kā REST resursu. Pēc tam tiek izveidots jauns resurss.



Sintakse: @httpPost

Piemērs:



Ierakstiet “RestApi_Post_Record.apxc” Apex klasi, kas ietver REST “POST” metodi, lai Salesforce objektā “Case” ievietotu statusa, prioritātes un tēmas laukus.





  1. Izveidojiet Post_Method ar trim parametriem: statusu, prioritāti un virknes veida tēmu.
  2. Izveidojiet objektu “Case”, nododot šos parametrus.
  3. Izmantojiet ievietošanas DML, lai ievietotu ierakstu Salesforce “Case” objektā.
@RestResource(urlMapping='/v56.0/RestApi_Post_Record/')
globālā klase RestApi_Post_Record{

// ATPŪTAS - Post Method
@httpPost
globālā statiskā Case Post_Method(virknes prioritāte, virknes statuss, virknes tēma){
Case case_obj= new Case(Priority=priority,Status = status,Subject=subject);

// Ievietot DML
ievietot case_obj;
return case_obj;
}
}

URI un rezultāts:

Dodieties uz Workbench un dodieties uz REST Explorer. Norādiet šādu URI un izpildiet to:



/services/apexrest/v56.0/RestApi_Post_Record/

Norādiet datus pieprasījuma pamattekstā:

{
'Prioritāte': 'Augsta',
'Statuss': 'Jauns',
'Subject': 'Mobilā problēma'
}

Atveriet ierakstu programmā Salesforce (lietotņu palaidējā pārejiet uz objektu “Case”).

Ievietojiet vienu ierakstu tieši no URI

Pārejiet uz REST Explorer cilnē “Utilītas” un norādiet šādu URI un norādiet šo ierakstu zem pieprasījuma pamatteksta:

/services/data/v56.0/sobjects/Case/

Pieprasījuma struktūra:

{
'Prioritāte': 'Vidēja',
'Statuss': 'Jauns',
'Tēma': 'Microsoft komandas — nenāk.'
}

Dodieties uz Salesforce cilni “Cases” un skatiet ierakstu.

Ievietojiet vairākus ierakstus tieši no URI

Ja vēlaties ievietot vairākus ierakstus vienlaikus, mums ir jānorāda URI šādi: /services/data/v56.0/composite/tree/sObject

Pieprasījuma iestāde glabā ierakstus šādā formātā:

'ieraksti' :[{
'attributes' : {'type' : 'Object', 'referenceId' : 'reference1'},
lauks:vērtība,
...
...
},{
'attributes' : {'type' : 'Object', 'referenceId' : 'reference1'},
lauks:vērtība,
...
...
}]
}

Ievietosim divus ierakstus Salesforce “Case” objektā.

URI: /services/data/v56.0/composite/tree/Case/

Pieprasījuma struktūra:

{
'ieraksti' :[{
'attributes' : {'type' : 'Case', 'referenceId' : 'reference1'},
'Prioritāte': 'Augsta',
'Statuss': 'Jauns',
'Subject':'Problēma ar mehānisko rotoru,
'Tips': 'Elektriskais'
},{
'attributes' : {'type' : 'Case', 'referenceId' : 'reference2'},
'Priority':'Zema',
'Statuss': 'Jauns',
'Subject': 'Ģeneratora palaišana pēc elektrības atteices' ,
'Tips': 'Elektriskais'
}]
}

Programmā Salesforce tiek ievietoti divi ieraksti ar CaseNumber 00001038 un 00001039.

PUT metode

Kā mēs iepriekš apspriedām, PUT ir http metode, ko izmanto, lai izveidotu/atjauninātu ierakstus. Šajā rokasgrāmatā mēs izmantojam šo metodi, lai izveidotu jaunu Salesforce ierakstu, izmantojot pielāgoto REST API.

@httpPut : šī metode tiek izsaukta, kad tiek nosūtīts HTTP PUT, kas nodrošina Apex metodi kā REST resursu. Pēc tam tiek izveidots jauns resurss vai atjaunināts esošais resurss.

Sintakse: @httpPut

Piemērs:

Ierakstiet “RestApi_Put_Record.apxc” Apex klasi, kas ietver REST “PUT” metodi, lai Salesforce objektā “Case” ievietotu statusa, prioritātes un apraksta laukus.

@RestResource(urlMapping='/v56.0/RestApi_Put_Record/')
globālā klase RestApi_Put_Record{

// ATPŪTAS - Put Method
@httpPut
globālā statiskā Case Put_Method(virknes prioritāte, virknes statuss, virknes priekšmets){
Case case_obj= new Case(Priority=priority,Status = status,Subject=subject);

// Ievietot DML
ievietot case_obj;
return case_obj;
}
}

URI un rezultāts:

Dodieties uz Workbench un dodieties uz REST Explorer. Norādiet šādu URI un izpildiet to:

/services/apexrest/v56.0/RestApi_Put_Record/

Norādiet datus pieprasījuma pamattekstā:

{
'Prioritāte': 'Augsta',
'Statuss': 'Slēgts',
'Tēma': 'Nepieciešams dārzeņu dzirnaviņas ceļvedis'
}

Atveriet ierakstu programmā Salesforce (lietotņu palaidējā pārejiet uz objektu “Case”).

Secinājums

Tagad varat ievietot ierakstus programmā Salesforce, izmantojot http PUT un POST metodes. Mēs uzzinājām, kā ievietot ierakstus tieši Workbench un izmantot pielāgoto REST API, izmantojot Apex klasi. Salesforce “Case” objekts šajā rokasgrāmatā ir izmantots kā piemērs. Faktiskā atšķirība starp PUT un POST ir tāda, ka POST tiek izmantots datu ievietošanai, savukārt PUT tiek izmantots datu ievietošanai/atjaunināšanai. @httpPut anotācija tiek izmantota PUT metodei un @httpPost anotācija tiek izmantota POST metodei.