Tutvustame Workbenchi
Workbench ei ole ametlik Salesforce.com-i toode. Kuid me kasutame Salesforce'i andmetega manipuleerimise toimingute tegemiseks, nagu valimine, sisestamine, muutmine, värskendamine ja kustutamine, logides sisse lihtsalt oma Salesforce'i kontole (toetab nii liivakasti kui ka tootmist). See on ametlik veebisait Workbenchi Salesforce'iga sisselogimiseks: https://workbench.developerforce.com/login.php .
Praeguse seisuga säilitage API versioon ainult olemasolevana ja klõpsake nuppu 'Logi sisse Salesforce'iga'.
Vajame REST Explorerit. Liikuge vahekaardile 'Utiliidid' ja klõpsake nuppu 'REST Explorer'.
Näete kasutajaliidest nagu järgmisel joonisel. Peame valima GET-i, et tuua Salesforce'ist kogu selle juhendi kirjed. Peame määrama URI, mis toob Salesforce'i kirjed, ja klõpsama nuppu 'Käivita'.
Hankige Salesforce'i ID-ga konkreetne kirje
Salesforce'i kirje ID põhjal saame tuua kogu Salesforce'i kirje. Peame määrama URI järgmiselt:
/ teenuseid / andmeid / v56.0 / nutab / objektAPIName / idSiin on 'objectAPIName' Salesforce'i standard-/kohandatud objekt ja 'id' viitab Salesforce'i ID-le.
Tagastamine:
Saate HTTP/1.1 200 OK töötlemata vastuse JSON-vormingus järgmiselt:
{'atribuudid' : {
'tüüp' :
'url' :
} ,
'väli' : väärtus,
...
}
Näide:
Selles näites toome juhtumikirje 5005i00000W4GM5AAN.
TÜÜP: / teenuseid / andmeid / v56.0 / nutab / Juhtum / 5005i00000W4GM5AANTulemus:
Näeme, et vastus genereeritakse JSON-vormingus.
Tulemusi saame vaadata ka otse siit:
Saate päringu abil hankida mitu kirjet
On aeg hankida Salesforce'i objektist mitu kirjet. Varem määrasime objektid URI-s. Siin peame määrama päringu, mis võtab päringu parameetrina.
URI: teenused / andmeid / v57.0 / päring / ? q =VALI+väli1,väli2,....+objektiAPINameMärksõnade ühendamiseks päringus peame eraldusmärgina kasutama '+'. See tagastab summa totalSize ja salvestab kausta. Iga kirje kausta nimi on [üksus 1],… [üksus n].
Näide 1:
Tagastame kirjed, mis sisaldavad juhtumi numbrit, olekut, prioriteeti ja kirjeldust objektist Case.
Tulemus:
Kui klõpsate nuppu 'Laienda kõik', näete kõiki kirjeid koos nende atribuutide ja väärtustega.
Lubage mul näidata esimest ja viimast plaati:
Näide 2:
Tagastame ainult kolm kirjet samade väljadega nagu esimeses näites.
Tulemus:
Tagatakse kaks esimest kirjet, mis esinevad objektis Case.
Näide 3:
Täpsustagem tingimus WHERE päringus, mis valib olekuga 'Uus' kirjed.
Tulemus:
Olekuga 'Uus' on viis kirjet.
Kohandatud puhkeressurss Apexis
Saame kasutada Salesforce Apexi, mis tagastab Salesforce'i objektilt kirje, määrates Workbenchis URI. REST-i kirjutamiseks Apexis peame kasutama mõningaid märkusi, mis pääsevad juurde teie Apexi klassi REST API-le. Veenduge, et meie Apexi klass peab olema globaalselt staatiline.
1. @RestResource Annotation
Seda märkust kasutatakse lubamiseks, mis paljastab Apexi klassi REST-ressursina. See võtab parameetrina urlMapping, mida kasutatakse URI asukoha leidmiseks töölauas.
Süntaks: @RestResource(urlMapping=’/Version/ApexClassName/’)
„Versioon” on teie Workbenchi versioon, nagu V56.0, ja „ApexClassName” on teie Apexi klass, kuhu on kaasatud Rest API ressursid.
2. @HttpGet Annotation
Seda märkust kasutatakse lubamiseks, mis paljastab Apexi klassi REST-ressursina. Seda kutsutakse siis, kui serverile saadetakse HTTP GET-i päring ja see tagastab määratud ressursi.
Süntaks: @httpGet
Näide 1: Üksik parameeter
Kirjutage 'RestApi_Get_Record.apxc' Apex-klass, mis hõlmab meetodit 'Rest Get', et tagastada Case objektist ID, CaseNumber, olek, prioriteet ja päritolu.
@ RestResource ( urlMapping = '/v56.0/RestApi_Get_Record/' )globaalne klass RestApi_Get_Record {
// REST – hankige meetod
@ httpHangi
globaalne staatiline juhtum getCaseDetails ( ) {
// Loo objekt jaoks Juhtumi objekt
Case case_obj = uus juhtum ( ) ;
Kaart < String, string > paramsMap = RestContext.request.params;
// Hankige juhtum id
String caseid = paramsMap.get ( 'sisend_id' ) ;
// SOQL päring, mis teeb tagasi id ,Case Number,Olek,Prioriteet,Päritolu juhtumist alates
// Case objekt
case_obj = [ vali id ,CaseNumber,Olek,Priority,Päritolu juhtumist, kus Id =:caseid ] ;
tagasi case_obj;
}
}
URI ja tulemus:
Avage Workbench ja navigeerige REST Exploreri juurde. Edastage ID kujul 5002t00000Pdzr2AAB parameetrile input_id.
/ teenuseid / tipus / v56.0 / RestApi_Get_Record / ? sisend_id =5002t00000Pdzr2AAB 
Selgitus:
- Looge juhtumi 'case_obj' jaoks objekt.
- Hankige parameetrid faili RestContext.request.params abil.
- Hankige juhtumi ID väärtusest param input_id ja salvestage see muutujasse caseid.
- Kirjutage SOQL-i päring, mis tagastab id, CaseNumber, oleku, prioriteedi, päritolu juhtumist juhtumi 'caseid' objektist Case.
- Tagastab juhtumiobjekti (case_obj).
Näide 2: Mitu parameetrit
Kasutage eelmist Apex-klassi ja hankige parameeter 'Olek' koos ID-ga. Määrake need kaks parameetrit Workbenchi URI-s, mis on eraldatud tähega '&'.
@ RestResource ( urlMapping = '/v56.0/RestApi_Get_Record/' )globaalne klass RestApi_Get_Record {
// REST – hankige meetod
@ httpHangi
globaalne staatiline juhtum getCaseDetails ( ) {
// Loo objekt jaoks Juhtumi objekt
Case case_obj = uus juhtum ( ) ;
Kaart < String, string > id_param = RestContext.request.params;
Kaart < String, string > status_param = RestContext.request.params;
// Hankige id_param parameetrisse case_id
String case_id = id_param.get ( 'sisend_id' ) ;
// Viige parameeter status_param olekusse case_status
String case_status =status_param.get ( 'staatus' ) ;
case_obj = [ vali id ,CaseNumber,Status,Priority,Origin from Case kus Id =:case_id ja Status =: case_status ] ;
tagasi case_obj;
}
}
URI ja tulemus:
Avage Workbench ja navigeerige REST Exploreri juurde. Edastage URI-s input_id kui 5002t00000PdzqwAAB ja olek 'Suletud'.
/ teenuseid / tipus / v56.0 / RestApi_Get_Record / ? sisend_id =5002t00000PdzqwAAB & olek =Suletud 
Järeldus
Arutasime kolme stsenaariumi Salesforce'i kirjete toomiseks Salesforce REST API kaudu, kasutades Workbenchi. Konkreetse kirje tagastamiseks peame määrama sObjecti, edastades id parameetrina URI-s. Samamoodi edastame konkreetsete kirjete saamiseks päringu parameetrid. Apexi abil saame luua oma „Hangi” meetodi, et valida kirje ühe või mitme parameetri põhjal.