retrieveRecord (αναφορά API προγράμματος-πελάτη)

Ανακτά μια εγγραφή πίνακα.

Σύνταξη

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

Παράμετροι

Ονομασία Δακτυλογραφώ Απαραίτητο Περιγραφή
entityLogicalName Συμβλοσειρά Όχι Το λογικό όνομα πίνακα της εγγραφής που θέλετε να ανακτήσετε. Για παράδειγμα: account.
id Συμβλοσειρά Όχι GUID της εγγραφής πίνακα που θέλετε να ανακτήσετε.
options Συμβλοσειρά όχι Επιλογές ερωτήματος συστήματος OData για τον έλεγχο των στοιχείων που επιστρέφονται. Ανατρέξτε στο θέμα Επιλογές
successCallback Function όχι Μια συνάρτηση για κλήση κατά την ανάκτηση μιας εγγραφής. Ένα αντικείμενο JSON με τις ανακτημένες ιδιότητες και τιμές που μεταβιβάζονται στη συνάρτηση.
errorCallback Function όχι Μια λειτουργία για κλήση όταν αποτύχει η λειτουργία. Διαβιβάζεται ένα αντικείμενο με τις ακόλουθες ιδιότητες:
- errorCode:Αριθμός. Ο κωδικός σφάλματος ως θετικός δεκαδικός αριθμός. Για παράδειγμα, ο κωδικός σφάλματος που τεκμηριώνεται ως 0x80040333 θα επιστραφεί ως 2147746611.
- message:Σειρά. Ένα μήνυμα λάθους που περιγράφει το ζήτημα.

Επιλογές

Για να ελέγξετε τα στοιχεία που επιστρέφονται, χρησιμοποιήστε τις $select επιλογές ερωτήματος συστήματος OData και $expand για να ανακτήσετε τα δεδομένα σας.

Χρησιμοποιήστε την $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

  • Last updated on