नमूना पोर्टल वेब API घटक कार्यान्वित करें
निम्नलिखित एक कोड घटक को लागू करने का एक उदाहरण है जो पोर्टल वेब API का उपयोग क्रियाएं बनाने, पुनर्प्राप्त करने, अपडेट करने और हटाने के लिए करता है. घटक चार बटनों को प्रस्तुत करता है, जिन पर विभिन्न वेब API क्रियाओं को शुरू करने के लिए क्लिक किया जा सकता है. वेब एपीआई कॉल के परिणाम को कोड घटक के नीचे एक HTML div कोड में इंजेक्ट किया जाता है.
पूर्वावश्यकताएँ
- आपका पोर्टल संस्करण 9.3.10.x या उच्चतर होना चाहिए.
- आपका स्टार्टर पोर्टल पैकेज 9.2.2103.x या उच्चतर का होना चाहिए.
- आपको अपने पोर्टल के लिए पोर्टल वेब API को सक्षम करने के लिए साइट सेटिंग को सक्षम करना होगा. वेब API के लिए साइट सेटिंग्स
- तालिका अनुमतियों का उपयोग करके तालिका सुरक्षा कॉन्फ़िगर करें. तालिका अनुमतियाँ
कोड
आप यहां से पूरा नमूना घटक डाउनलोड कर सकते हैं.
डिफ़ॉल्ट रूप से, नमूने में, घटक को वेब API उदाहरणों में बनाने, पुनर्प्राप्त करने, नाम और राजस्व फ़ील्ड सेट करने के लिए कॉन्फ़िगर किया गया है.
किसी तालिका या कॉलम में डिफ़ॉल्ट कॉन्फ़िगरेशन को बदलने के लिए, दिखाए गए अनुसार नीचे दिए गए कॉन्फ़िगरेशन मानों को अपडेट करें
private static \_entityName = "account";
private static \_requiredAttributeName = "name";
private static \_requiredAttributeValue = "Web API Custom Control (Sample)";
private static \_currencyAttributeName = "revenue";
private static \_currencyAttributeNameFriendlyName = "annual revenue";
createRecord पद्धति तीन बटनों को प्रस्तुत करती है, जो आपको विभिन्न मानों (100, 200, 300) पर सेट राजस्व फ़ील्ड के साथ एक खाता रिकॉर्ड बनाने की अनुमति देता है.
जब आप क्रिएट बटन में से किसी एक को चुनते हैं, तो बटन का onClick ईवेंट हैंडलर चयनित बटन के मान की जांच करता है और बटन के मान पर सेट राजस्व फ़ील्ड के साथ खाता रिकॉर्ड बनाने के लिए वेब API क्रिया का उपयोग करता है. खाता रिकॉर्ड का नाम फ़ील्ड वेब API कोड घटक (नमूना) पर सेट किया जाएगा, जिसमें स्ट्रिंग के अंत में एक यादृच्छिक int जोड़ा जाएगा. वेब API कॉल से कॉलबैक विधि कॉल के परिणाम (सफलता या विफलता) को कस्टम नियंत्रण के परिणाम div में इंजेक्ट करती है.
deleteRecord विधि एक बटन प्रस्तुत करती है जो ड्रॉपडाउन में चयनित रिकॉर्ड को हटा देता है. ड्रॉपडाउन नियंत्रण आपको वह खाता रिकॉर्ड चुनने की अनुमति देता है जिसे आप हटाना चाहते हैं. ड्रॉपडाउन से एक खाता रिकॉर्ड चुने जाने और रिकॉर्ड हटाएं बटन चुने जाने के बाद, रिकॉर्ड हटा दिया जाता है. वेब API कॉल से कॉलबैक विधि कॉल के परिणाम (सफलता या विफलता) को कस्टम नियंत्रण के परिणाम div में इंजेक्ट करती है.
FetchXMLretrieveMultiple विधि कोड घटक में एक बटन प्रस्तुत करती है। जब इस बटन की onClick विधि को कॉल किया जाता है, तो FetchXML जनरेट किया जाता है और सभी खाता रिकॉर्ड के लिए राजस्व फ़ील्ड के औसत मान की गणना करने के लिए retrieveMultiple फ़ंक्शन को पास किया जाता है। वेब API कॉल से कॉलबैक विधि कॉल के परिणाम (सफलता या विफलता) को कस्टम नियंत्रण के परिणाम div में इंजेक्ट करती है.
OData retrieveMultiple विधि कोड घटक में एक बटन प्रस्तुत करती है. जब इस बटन की onClick विधि को कॉल किया जाता है, तो एक OData स्ट्रिंग उत्पन्न होती है और कोड घटक वेब एपीआई (नमूना) जैसे नाम फ़ील्ड के साथ सभी खाता रिकॉर्ड पुनर्प्राप्त करने के लिए retrieveMultiple फ़ंक्शन को पास की जाती है, जो इस कोड घटक द्वारा बनाए गए सभी खाता रिकॉर्ड के लिए सही है.
रिकॉर्ड्स को सफलतापूर्वक पुनर्प्राप्त करने पर, कोड घटक के पास यह गिनने के लिए तर्क होता है कि कितने खाता रिकॉर्ड में राजस्व फ़ील्ड 100, 200 या 300 पर सेट है, और इस गणना को कोड घटक पर OData स्थिति कंटेनर div में प्रदर्शित करता है. वेब API कॉल से कॉलबैक विधि कॉल के परिणाम (सफलता या विफलता) को कस्टम नियंत्रण के परिणाम div में इंजेक्ट करती है.