Salesforce Rest API

Salesforce Rest Api



במדריך זה, נדון כיצד להכניס את הרשומות ל-Salesforce עם REST API באמצעות שיטות POST ו-PUT http ב-Workbench. כחלק ממדריך זה, נדון כיצד להשתמש ב-Workbench ולהביא רשומות ספציפיות באמצעות sObject, להביא מספר רשומות מאובייקט באמצעות שאילתה, ואחזר את הרשומות על ידי כתיבת ה-API REST המותאם אישית של Apex.

שיטת POST

POST היא שיטה http אשר מוסיפה רשומות בודדות/מרובות בכל פעם לתוך Salesforce. אנחנו יכולים להכניס את הרשומות עם URI דרך ה-API של Apex REST המותאם אישית או ישירות מ-URI.

משאב מנוחה מותאם אישית ב- Apex

כדי לכתוב REST ב- Apex, עלינו להשתמש בכמה הערות הניגשות ל- REST API במחלקת Apex שלך.







@HttpPost הערה

שיטה זו נקראת כאשר HTTP POST נשלחת המאפשרת את חשיפת שיטת Apex כמשאב REST. לאחר מכן, הוא יוצר משאב חדש.



תחביר: @httpPost

דוגמא:



כתוב את מחלקת 'RestApi_Post_Record.apxc' Apex הכוללת את שיטת REST 'POST' כדי להוסיף את שדות הסטטוס, העדיפות והנושא לאובייקט 'Case' של Salesforce.





  1. צור את Post_Method עם שלושה פרמטרים: סטטוס, עדיפות ונושא סוג המחרוזת.
  2. צור אובייקט 'מקרה' על ידי העברת פרמטרים אלה.
  3. השתמש ב-Insert DML כדי להכניס את הרשומה לאובייקט 'Case' של Salesforce.
@RestResource(urlMapping='/v56.0/RestApi_Post_Record/')
מחלקה עולמית RestApi_Post_Record{

// REST - שיטת פוסט
@httpPost
Global static Case Post_Method(String Priority, String Status,String Subject){
Case case_obj= new Case(Priority=עדיפות,סטטוס=סטטוס,נושא=נושא);

// הכנס DML
הכנס case_obj;
החזר case_obj;
}
}

URI ותוצאה:

עבור אל Workbench ונווט אל REST Explorer. ציין את ה-URI הבא והפעל אותו:



/services/apexrest/v56.0/RestApi_Post_Record/

ציין את הנתונים בגוף הבקשה:

{
'עדיפות': 'גבוה',
'סטטוס': 'חדש',
'נושא': 'בעיה ניידת'
}

פתח את הרשומה ב-Salesforce (נווט אל האובייקט 'מקרה' ממפעיל האפליקציות).

הכנס רשומה בודדת ישירות מ-URI

נווט אל סייר REST תחת הכרטיסייה 'כלי עזר' וציין את ה-URI הבא וציין רשומה זו תחת גוף הבקשה:

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

גוף הבקשה:

{
'Priority': 'בינוני',
'סטטוס': 'חדש',
'נושא': 'צוותי מיקרוסופט - לא מגיע'
}

עבור אל הכרטיסייה 'מקרים' של Salesforce והצג את הרשומה.

הוסף רשומות מרובות ישירות מ-URI

אם ברצונך להוסיף מספר רשומות בו-זמנית, עלינו לציין את ה-URI באופן הבא: /services/data/v56.0/composite/tree/sObject

גוף הבקשה מחזיק את הרשומות בפורמט הבא:

'רשומות' :[{
'attributes' : {'type' : 'Object', 'referenceId' : 'reference1'},
field:value,
...
...
},{
'attributes' : {'type' : 'Object', 'referenceId' : 'reference1'},
field:value,
...
...
}]
}

בואו נכניס שתי רשומות לאובייקט 'מקרה' של Salesforce.

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

גוף הבקשה:

{
'רשומות' :[{
'attributes' : {'type' : 'מקרה', 'referenceId' : 'reference1'},
'עדיפות': 'גבוהה',
'סטטוס': 'חדש',
'Subject':'בעיית עיצוב עם רוטור מכני',
'סוג': 'חשמלי'
},{
'attributes' : {'type' : 'מקרה', 'referenceId' : 'reference2'},
'עדיפות': 'נמוכה',
'סטטוס': 'חדש',
'Subject': 'הפעלת גנרטור לאחר תקלה חשמלית' ,
'סוג': 'חשמלי'
}]
}

שתי רשומות מוכנסות ל-Salesforce עם CaseNumber 00001038 ו-00001039.

שיטת PUT

כפי שדיברנו בעבר, PUT היא שיטת http המשמשת ליצירה/עדכון של הרשומות. במדריך זה, אנו משתמשים בשיטה זו כדי ליצור רשומת Salesforce חדשה באמצעות REST API המותאם אישית.

@httpPut : שיטה זו נקראת כאשר נשלח ה-HTTP PUT המאפשר את חשיפת שיטת Apex כמשאב REST. לאחר מכן, הוא יוצר משאב חדש או עדכן את המשאב הקיים.

תחביר: @httpPut

דוגמא:

כתוב את מחלקת 'RestApi_Put_Record.apxc' Apex הכוללת את שיטת REST 'PUT' כדי להוסיף את שדות הסטטוס, העדיפות והתיאור לאובייקט 'Case' של Salesforce.

@RestResource(urlMapping='/v56.0/RestApi_Put_Record/')
מחלקה עולמית RestApi_Put_Record{

// REST - שיטת Put
@httpPut
Global static Case Put_Method(String Priority, String Status,String Subject){
Case case_obj= new Case(Priority=עדיפות,סטטוס=סטטוס,נושא=נושא);

// הכנס DML
הכנס case_obj;
החזר case_obj;
}
}

URI ותוצאה:

עבור אל Workbench ונווט אל REST Explorer. ציין את ה-URI הבא והפעל אותו:

/services/apexrest/v56.0/RestApi_Put_Record/

ציין את הנתונים בגוף הבקשה:

{
'עדיפות': 'גבוה',
'סטטוס': 'סגור',
'נושא': 'דרוש מדריך לטחנת ירקות'
}

פתח את הרשומה ב-Salesforce (נווט אל האובייקט 'מקרה' ממפעיל האפליקציות).

סיכום

כעת, אתה יכול להכניס את הרשומות לתוך Salesforce באמצעות שיטות http PUT ו-POST. למדנו כיצד להכניס את הרשומות ישירות ל-Workbench ולהשתמש ב- REST API המותאם אישית דרך מחלקת Apex. אובייקט Salesforce 'Case' משמש במדריך זה כדוגמה. ההבדל בפועל בין PUT ל-POST הוא ש-POST משמש להכנסת הנתונים ואילו PUT משמש להכנסת/עדכון הנתונים. ההערה @httpPut משמשת עבור שיטת PUT והביאור @httpPost משמש עבור שיטת POST.