retrieveRecord (חומר עזר עבור API של לקוח)

אחזור רשומת טבלה.

תחביר

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parameters

שם	Type	נדרש	תיאור
entityLogicalName	String	כן	השם הלוגי של הטבלה של הרשומה שברצונך לאחזר. לדוגמה: account.
id	String	כן	GUID של רשומת הטבלה שברצונך לאחזר.
options	String	לא	אפשרויות שאילתה של מערכת OData לשליטה בפריטים המוחזרים. ראה אפשרויות
successCallback	פונקציה	לא	פונקציה שיש לקרוא לה בעת אחזור רשומה. אובייקט JSON עם המאפיינים והערכים המאוחזרים שהועברו לפונקציה.
errorCallback	פונקציה	לא	פונקציה שיש לקרוא לה כאשר הפעולה נכשלת. אובייקט עם המאפיינים הבאים מועבר: - errorCode:מספר. קוד השגיאה כמספר עשרוני חיובי. לדוגמה, קוד השגיאה שתועד כפי 0x80040333 שהוא יוחזר בתור 2147746611. - message:מחרוזת. הודעת שגיאה המתארת את הבעיה.

אפשרויות

כדי לקבוע מה יוחזר, השתמש באפשרויות השאילתה $select$expand של מערכת OData ו- OData כדי לאחזר את הנתונים שלך.

השתמש באפשרות $select שאילתת המערכת כדי להגביל את המאפיינים המוחזרים על-ידי הכללת רשימה מופרדת באמצעות פסיקים של שמות מאפיינים. בחירת מאפיינים ספציפיים היא שיטות עבודה מומלצות חשובות לביצועים. אם מאפיינים לא מצוינים באמצעות $select, כל המאפיינים מוחזרים.

השתמש באפשרות $expand שאילתת המערכת כדי לקבוע אילו נתונים מטבלאות קשורות יוחזרו. אם תכלול רק את שם מאפיין הניווט, תקבל את כל המאפיינים עבור רשומות קשורות. באפשרותך להגביל את המאפיינים המוחזרים עבור רשומות $select קשורות באמצעות אפשרות שאילתת המערכת בסוגריים לאחר שם מאפיין הניווט. השתמש באפשרות זו הן עבור מאפייני ניווט בעלי ערך יחיד והן עבור מאפייני ניווט בעלי ערך אוסף . במצב לא מקוון, אנו תומכים רק באפשרות המקוננת $select בתוך $expand.

עליך לציין את אפשרויות השאילתה המתחילות ב- ?. באפשרותך גם לציין אפשרויות שאילתה מרובות באמצעות & הפרדת אפשרויות השאילתה. לדוגמה:

?$select=name&$expand=primarycontactid($select=contactid,fullname)

ראה דוגמאות כדי לראות כיצד באפשרותך להגדיר את פרמטר האפשרויות עבור תרחישי אחזור שונים.

ערך החזרה

בעת הצלחה, החזרת הבטחה המכילה אובייקט JSON עם העמודות המאוחזרות והערכים שלהן. אם הרשומה המבוקשת אינה קיימת, מחזירה שגיאה.

דוגמאות

עיין בדוגמאות הבאות:

• אחזר בסיסי
• אחזור טבלאות קשורות עבור מופע טבלה על-ידי הרחבת מאפייני ניווט עם ערך יחיד

אחזר בסיסי

אחזור השם וההכנסות של רשומת חשבון עם מזהה רשומה = 5531d753-95af-e711-a94e-000d3a11e605.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

הדוגמה לעיל מציגה את הטקסט הבא בקונסולה שלך; ייתכן שתראה ערכים אחרים בהתאם לנתונים שלך:

Retrieved values: Name: Sample Account, Revenue: 5000000

אחזור טבלאות קשורות עבור מופע טבלה על-ידי הרחבת מאפייני ניווט עם ערך יחיד

הדוגמה הבאה מדגימה כיצד לאחזר את איש הקשר עבור רשומת תיק לקוח עם מזהה רשומה = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. עבור רשומת איש הקשר הקשורה, אנו מאחזרים רק את המאפיינים contactidו- fullname .

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

הדוגמה לעיל מציגה את הטקסט הבא בקונסולה שלך; ייתכן שתראה ערכים אחרים בהתאם לנתונים שלך:

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

מאמרים קשורים

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi