Dela via

executeEvent (klient-API-referens) (förhandsversion)

Viktigt!

  • Det här är en förhandsgranskningsfunktion.
  • Förhandsversionsfunktioner är inte avsedda för produktionsanvändning och kan ha begränsade funktioner. Dessa funktioner omfattas av kompletterande användningsvillkor och är tillgängliga före en officiell version så att kunderna kan få tidig åtkomst och ge feedback.

Kör ett Microsoft Copilot Studio-ämne baserat på det registrerade händelsenamnet. Returnerar en matris av typen MCSResponse.

Syntax

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

Parameterar

Parameternamn Typ Krävs Description
eventName snöre Yes Händelsenamn som registrerats i Microsoft Copilot Studio-ämnet
eventParameters Okänd Yes Parametrar som behövs för händelsekörningen. Dessa beror på vad ämnet gör.
successCallback Funktion Yes En funktion som ska anropas när åtgärden lyckas.
errorCallback Funktion Yes En funktion som ska anropas när åtgärden misslyckas.

Returvärde

En matris med MCSResponse

Åtkomst till appkontext

När ett agent-API anropas skickas kontexten för appen till Copilot Studio-ämnet via en uppsättning variabler. Följande är sammanhangsvariabler som är tillgängliga som globala Variabler i Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID för tabellposten i huvudformuläret
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logiskt namn på tabellen på huvudsidan
Global.PA__Copilot_Model_PageContext.pageContext.pageName Namnet på huvudsidan
Global.PA__Copilot_Model_PageContext.pageContext.pageType Typ av huvudsida
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Unikt namn på den modelldrivna appen

Du kan till exempel hämta formulärets post med hjälp av Global.PA__Copilot_Model_PageContext.pageContext.id.guid och Global.PA__Copilot_Model_PageContext.pageContext.entityTypeNamefrån Dataverse.

Åtkomst till eventParameters

I Avsnittet Copilot Studio eventParameters kan du komma åt från API-anropet med hjälp av variabeln Activity.Value. Använd parsningsvärdenoden för att konvertera JSON till en post med ett eller flera fält. Om du väljer Från exempeldata för Datatyp kan du tillhandahålla ett JSON-exempel för att skapa posten.

Example

I Microsoft Copilot Studio, där ett ämne är registrerat som accepterar ett ID (entitetspost-ID) som indataparameter. Baserat på indata hämtar den relaterade aktiviteter för entitetsposten och returnerar resultatet som en Copilot Studio-händelseaktivitet.

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

Svar

[
    {
        "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 (klient-API-referens)

  • Last updated on