के माध्यम से साझा करें


executeEvent (क्लाइंट एपीआई संदर्भ) (पूर्वावलोकन)

महत्त्वपूर्ण

  • यह एक पूर्वावलोकन सुविधा है.
  • पूर्वावलोकन सुविधाएं उत्पादन उपयोग के लिए नहीं हैं और उनकी कार्यक्षमता सीमित हो सकती है. ये सुविधाएँ उपयोग की पूरक शर्तों के अधीन हैं, और आधिकारिक रिलीज़ से पहले उपलब्ध हैं ताकि ग्राहक शीघ्र पहुँच प्राप्त कर सकें और प्रतिक्रिया दे सकें।

पंजीकृत ईवेंट नाम के आधार पर Microsoft Copilot Studio विषय निष्पादित करता है। MCSResponse प्रकार की एक सरणी देता है।

सिंटैक्स

Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

पैरामीटर

पैरामीटर नाम प्रकार आवश्य या क़िस्‍म
eventName स्ट्रिंग हाँ Microsoft Copilot Studio विषय में पंजीकृत ईवेंट का नाम
eventParameters अज्ञात हाँ घटना निष्पादन के लिए आवश्यक पैरामीटर। ये इस बात पर निर्भर करते हैं कि विषय क्या करता है।
successCallback फ़ंक्शन हाँ ऑपरेशन सफल होने पर कॉल करने के लिए एक फ़ंक्शन।
errorCallback फ़ंक्शन हाँ ऑपरेशन विफल होने पर कॉल करने के लिए एक फ़ंक्शन।

वापसी मान

MCSResponse की एक सरणी

ऐप संदर्भ तक पहुँचना

जब किसी एजेंट एपीआई को कॉल किया जाता है, तो ऐप के लिए संदर्भ को चर के एक सेट के माध्यम से Copilot Studio विषय पर भेजा जाता है। निम्नलिखित संदर्भ चर हैं जो Copilot Studio वैश्विक चर के रूप में उपलब्ध हैं।

चर या क़िस्‍म
Global.PA__Copilot_Model_PageContext.pageContext.id.guid मुख्य प्रपत्र पर तालिका रिकॉर्ड की ID
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName मुख्य पृष्ठ में तालिका का तार्किक नाम
Global.PA__Copilot_Model_PageContext.pageContext.pageName मुख्य पृष्ठ का नाम
Global.PA__Copilot_Model_PageContext.pageContext.pageType मुख्य पृष्ठ का प्रकार
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName मॉडल-चालित ऐप का अद्वितीय नाम

उदाहरण के लिए, और का Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNameउपयोग करकेGlobal.PA__Copilot_Model_PageContext.pageContext.id.guid, फॉर्म का रिकॉर्ड Dataverse से पुनर्प्राप्त किया जा सकता है।

इवेंटपैरामीटर्स तक पहुँचना

Copilot Studio विषय के भीतर, eventParameters एपीआई कॉल से वैरिएबल Activity.Valueका उपयोग करके एक्सेस किया जा सकता है। JSON को एक या अधिक फ़ील्ड वाले रिकॉर्ड में बदलने के लिए पार्स मान नोड का उपयोग करें। डेटा प्रकारके लिए नमूना डेटा से चयन करने से रिकॉर्ड बनाने के लिए JSON उदाहरण प्रदान करने की अनुमति मिलती है।

उदाहरण

Microsoft Copilot Studio में, जहां एक विषय पंजीकृत है जो इनपुट पैरामीटर के रूप में एक आईडी (इकाई रिकॉर्ड आईडी) स्वीकार करता है। इनपुट के आधार पर, यह उस इकाई रिकॉर्ड की संबंधित गतिविधियों को पुनः प्राप्त करता है और परिणामों को एक Copilot Studio ईवेंट गतिविधि के रूप में लौटाता है।

const response = await Xrm.Copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"}); 

प्रत्युत्तर

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

Xrm.Copilot (क्लाइंट एपीआई संदर्भ)