API γενικού περιβάλλοντος υπολογισμού εκπομπών
Μπορείτε να χρησιμοποιήστε το ΑΡΙ msdyn_runEmissionCalculationService για να υπολογίσετε το κόστος για δραστηριότητες που χρησιμοποιούν ένα μοντέλο υπολογισμού χωρίς να δημιουργήσετε ένα προφίλ υπολογισμού. Ως συνδρομητής του, μπορείτε να Microsoft Sustainability Manager χρησιμοποιήσετε αυτήν τη διεύθυνση URL για πρόσβαση στο API:
{organization url}/api/data/v{version}/msdyn_runEmissionCalculationService
Σε αυτήν τη διεύθυνση URL, η διεύθυνση URL του οργανισμού αναφέρεται στη βασική διεύθυνση URL του οργανισμού Microsoft Sustainability Manager στην οποία εγκαθίσταται και ο χρήστης μπορεί να αποκτήσει πρόσβαση. Η έκδοση αναφέρεται στην έκδοση web API (για παράδειγμα, 9.2).
Λήψη αναγνωριστικών οντότητας
Υπάρχουν πολλοί τρόποι με τους οποίους μπορείτε να λάβετε τα αναγνωριστικά για οντότητες, όπως τα δεδομένα δραστηριοτήτων και το μοντέλο υπολογισμού. Αυτά περιλαμβάνουν το XRM WebAPI, το API του προγράμματος-πελάτη και απευθείας μέσω της διεύθυνσης URL της οντότητας στην οποία βρίσκεται Microsoft Sustainability Manager.
Παράμετροι εισόδου
Ως προσαρμοσμένο Dataverse API, ο χρόνο εκτέλεσης του ΑΡΙ υπολογισμού γενικής χρήσης εκτελείται στα δύο λεπτά. Το χρονικό όριο για μεγαλύτερους υπολογισμούς έληξε, επομένως το μέγεθος των καταχωρίσεων περιορίζεται σύμφωνα με τον ακόλουθο πίνακα.
| Ονομασία | Type | Υποχρεωτικό; | Περιγραφή |
|---|---|---|---|
| activityIds | Πίνακας συμβολοσειρών | Όχι | Λίστα αναγνωριστικών των καρτελών δεδομένων δραστηριότητας που θα χρησιμοποιηθούν στον υπολογισμό. Έως 500 αναγνωριστικά δραστηριοτήτων μπορούν να συμπεριληφθούν στην εισαγωγή. |
| calculationModelId | Συμβλοσειρά | Όχι | Το αναγνωριστικό του μοντέλου υπολογισμού που χρησιμοποιείται στον υπολογισμό των εκπομπών. |
| έκδοση | Συμβλοσειρά | όχι | Ο αριθμός έκδοσης του API προσδιορίζει την έκδοση του API που πρέπει να καλείται. Αυτήν τη στιγμή το 1.0.0 είναι η μόνη διαθέσιμη έκδοση. Εάν δεν καθορίζεται, χρησιμοποιήστε την "τελευταία" έκδοση. |
Παράμετροι εξόδου
Στο υψηλότερο επίπεδο, η έξοδος είναι μια συμβολοσειρά JSON που περιέχει μια λίστα γενικά προσαρμοσμένων οντοτήτων εξόδου. Για κάθε επιλέξιμη δραστηριότητα, η οντότητα εξόδου ενδέχεται να περιέχει σφάλματα που έχουν αξιολογηθεί ή σφάλματα που παρουσιάστηκαν κατά τον υπολογισμό με βάση το εάν ο υπολογισμός ήταν επιτυχημένος. Να ελέγχετε πάντα την σημαία IsErrorRecord μιας εξαγόμενης εγγραφής πριν να προσπαθείτε να αποκτήσετε πρόσβαση σε αυτό.
Γενική οντότητα εξόδου εκτύπωσης
Η γενική οντότητα εξόδου με το αποτέλεσμα της αύξησης των επενδύσεων δεν υπάρχει Dataverse. Πρόκειται για μια συλλογή σχετικών χαρακτηριστικών από την οντότητα που διαθέτει το σύστημα καταγραφής και την οντότητα σφάλματος υπολογισμού. Το ΑΡΙ υπολογισμού γενικής χρήσης επιστρέφει μια λίστα αυτών των οντοτήτων, με κάθε οντότητα να αντιστοιχεί σε μια καρτέλα δεδομένων δραστηριότητας που μπορεί να είναι κατάλληλη για την εισαγωγή.
Η οντότητα εξαγωγής έχει τα εξής χαρακτηριστικά:
| Ονομασία | Type | Περιγραφή |
|---|---|---|
| ActivityId | Συμβλοσειρά | Το αναγνωριστικό της εγγραφής δεδομένων δραστηριότητας για τον υπολογισμό. |
| ActivityName | Συμβλοσειρά | Το όνομα της εγγραφής δεδομένων δραστηριότητας για τον υπολογισμό. |
| IsErrorRecord | Boolean | Μια δυαδική τιμή που υποδεικνύει αν ο υπολογισμός για τη συγκεκριμένη δραστηριότητα συναντά σφάλματα. Εάν η τιμή true, ο υπολογισμός απέτυχε και τα σφάλματα που παρουσιάστηκαν μπορούν να προβληθούν μέσω του χαρακτηριστικού ErrorJson. |
| ErrorJson | Συμβλοσειρά | Συμβολοσειρά JSON που αναπαριστά τυχόν σφάλματα υπολογισμού που παρουσιάστηκαν κατά την επεξεργασία αυτής της δεδομένης δραστηριότητας. Αυτή η τιμή είναι null εάν η τιμή IsErrorRecord είναι ψευδής. |
| Ονομασία | Συμβλοσειρά | Το όνομα του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Αυτή η τιμή είναι null εάν η τιμή IsErrorRecord είναι αληθής. |
| CH4 | Δεκαδικός αριθμός | Η τιμή CH4 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CH4. |
| CH4Unit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή CH4 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CH4. |
| CO2 | Δεκαδικός αριθμός | Η τιμή CO2 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CO2. |
| CO2Unit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή CO2 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CO2. |
| CO2e | Δεκαδικός αριθμός | Η τιμή CO2e του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CO2e. |
| CO2eUnit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή CO2e του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει CO2e. |
| HFC | Δεκαδικός αριθμός | Η τιμή HFC του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει HFC. |
| HFCsUnit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή HFC του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει HFC. |
| N2O | Δεκαδικός αριθμός | Η τιμή N2O του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει N2O. |
| N2OUnit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή N2O του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει N2O. |
| NF3 | Δεκαδικός αριθμός | Η τιμή NF3 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει NF3. |
| NF3Unit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή NF3 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει NF3. |
| PFC | Δεκαδικός αριθμός | Η τιμή PFC του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει PFC. |
| PFCsUnit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή PFC του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει PFC. |
| SF6 | Δεκαδικός αριθμός | Η τιμή SF6 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει SF6. |
| SF6Unit | Συμβλοσειρά | Το όνομα της μονάδας για τη τιμή SF6 του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει SF6. |
| OtherGHGs | Δεκαδικός αριθμός | Η τιμή άλλων αερίων του θερμοκηπίου του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι 0 εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει άλλα GHG. |
| OtherGHGsUnit | Συμβλοσειρά | Όνομα της μονάδας τιμών άλλων αερίων του θερμοκηπίου του υπολογισμού εκπομπής για αυτήν τη δραστηριότητα. Η τιμή αυτή είναι null εάν η τιμή IsErrorRecord είναι αληθής ή εάν η δοκιμή διόρθωσης δεν περιέχει άλλα GHG. |
Παραδείγματα
Στο παρακάτω παράδειγμα, το API καλείται με ένα έγκυρο αναγνωριστικό δεδομένων δραστηριότητας που έχει ως αποτέλεσμα μια απάντηση χωρίς σφάλμα.
Δεδομένα εισόδου:
{
"activityDataIds": [
"decc7c96-9180-ed11-aacf-000d3a1477fd”
],
"calculationModelId": "0b533a50-399e-ec11-b400-00224823f2de",
"version": "1.0.0"
}
Δεδομένα εξόδου:
[
{
"ActivityId": "decc7c96-9180-ed11-aacf-000d3a1477fd",
"ActivityName": "Passenger car",
"IsErrorRecord": false,
"ErrorJson": null,
"Name": "Employee Commuting 526",
"CH4": 2267.832,
"CH4Unit": "g",
"CO2": 107560.032,
"CO2Unit": "kg",
"CO2e": 108292.541736,
"CO2eUnit": kg,
"HFCs": 0,
"HFCsUnit": null,
"N2O": 2267.832,
"N2OUnit": "g",
"NF3": 0,
"NF3Unit": null,
"PFCs": 0,
"PFCsUnit": null,
"SF6": 0,
"SF6Unit": null,
"OtherGHGs": 0,
"OtherGHGsUnit": null
}
]
Στο παρακάτω παράδειγμα, το API καλείται με ένα μη έγκυρο αναγνωριστικό δεδομένων δραστηριότητας με αποτέλεσμα την απόκριση με σφάλμα. Στην εν λόγω καρτέλα δραστηριότητας λείπει το πεδίο κόστους, το οποίο απαιτεί το μοντέλο υπολογισμού στην εισαγωγή. Ως εκ τούτου, η καρτέλα εξόδου έχει ένα σφάλμα JSON που περιέχει τη στοίβα εξαιρέσεων υπολογισμού που προκύπτουν κατά την αξιολόγηση της καρτέλας. Ο κωδικός σφάλματος εξυπηρέτησης των εξαιρέσεων που παρουσιάστηκαν μπορεί να βοηθήσει το χρήστη να κατανοήσει τι παρουσιάστηκε. Σε αυτήν την περίπτωση, το EmissionCalculationActionFieldValueNullBlankException δηλώνει ότι το απαιτούμενο πεδίο είναι κενό.
Δεδομένα εισόδου:
{
"activityDataIds": [
"22a8b098-4b8b-ed11-aad1-000d3a5bc56a"
],
"calculationModelId": "0b533a50-399e-ec11-b400-00224823f2de",
"version": "1.0.0"
}
Δεδομένα εξόδου:
[
{
"ActivityId": "22a8b098-4b8b-ed11-aad1-000d3a5bc56a",
"ActivityName": null,
"IsErrorRecord": true,
"ErrorJson": {
"ServiceErrorCode": "ActivityCalculationModelExecutionException",
"UserMessageParameters": [
"Invalid Fugitive Emissions"
],
"InnerException": {
"ServiceErrorCode": "EmissionCalculationActionFieldValueNullBlankException",
"UserMessageParameters": [
"Action 1"
],
"InnerException": {
"ServiceErrorCode": null,
"UserMessageParameters": null,
"InnerException": {
"ServiceErrorCode": null,
"UserMessageParameters": null,
"InnerException": null
}
}
}
},
"Name": null,
"CH4": 0,
"CH4Unit": null,
"CO2": 0,
"CO2Unit": null,
"CO2e": 0,
"CO2eUnit": null,
"HFCs": 0,
"HFCsUnit": null,
"N2O": 0,
"N2OUnit": null,
"NF3": 0,
"NF3Unit": null,
"PFCs": 0,
"PFCsUnit": null,
"SF6": 0,
"SF6Unit": null,
"OtherGHGs": 0,
"OtherGHGsUnit": null
}]
]
Κλήση προσαρμοσμένων API
Για περισσότερες πληροφορίες, μεταβείτε στην επιλογή Δημιουργία και χρήση προσαρμοσμένων API.
