Sdílet prostřednictvím

executeEvent (reference k rozhraní API klienta) (Preview)

Důležité

  • Toto je funkce ve verzi Preview.
  • Funkce ve verzi Preview nejsou určené pro produkční použití a můžou mít omezené funkce. Tyto funkce podléhají dodatečným podmínkám použití a jsou k dispozici před oficiálním vydáním, aby zákazníci mohli získat přednostní přístup a poskytnout zpětnou vazbu.

Spustí téma aplikace Microsoft Copilot Studio na základě registrovaného názvu události. Vrátí pole typu MCSResponse.

Syntaxe

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

Parametry

Název parametru Typ Povinné Description
eventName řetězec Ano Název události zaregistrovaný v tématu aplikace Microsoft Copilot Studio
eventParameters Neznámý Ano Parametry potřebné pro provádění události. To závisí na tom, co téma dělá.
successCallback Funkce Ano Funkce, která se má volat po úspěšném provedení operace.
errorCallback Funkce Ano Funkce, která se má volat v případě selhání operace.

Návratová hodnota

Pole MCSResponse

Přístup k kontextu aplikace

Při volání rozhraní API agenta se kontext aplikace předá do tématu Copilot Studio prostřednictvím sady proměnných. Následují kontextové proměnné, které jsou k dispozici jako globální proměnné copilot studia.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID záznamu tabulky v hlavním formuláři
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logický název tabulky na hlavní stránce
Global.PA__Copilot_Model_PageContext.pageContext.pageName Název hlavní stránky
Global.PA__Copilot_Model_PageContext.pageContext.pageType Typ hlavní stránky
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Jedinečný název modelem řízené aplikace

Například pomocí Global.PA__Copilot_Model_PageContext.pageContext.id.guid a Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, záznam formuláře lze načíst z Dataverse.

Přístup k eventParameters

V tématu eventParameters Copilot Studio lze k volání rozhraní API přistupovat pomocí proměnné Activity.Value. Pomocí uzlu parsovat hodnotu převedete JSON na záznam s jedním nebo více poli. Výběr ukázkových dat pro datový typ umožňuje poskytnout příklad JSON pro vytvoření záznamu.

Example

V aplikaci Microsoft Copilot Studio, kde je zaregistrované téma, které přijímá ID (ID záznamu entity) jako vstupní parametr. Na základě vstupu načte související aktivity tohoto záznamu entity a vrátí výsledky jako aktivitu události Copilot Studio.

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

Odezva

[
    {
        "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 (referenční informace k rozhraní API klienta)

  • Last updated on