Udostępnij przez

executeEvent (dokumentacja interfejsu API klienta) (wersja zapoznawcza)

Ważne

  • Jest to funkcja w wersji zapoznawczej.
  • Funkcje w wersji zapoznawczej nie są przeznaczone do użytku produkcyjnego i mogą mieć ograniczone funkcje. Te funkcje podlegają dodatkowym warunkom użytkowania i są dostępne przed oficjalną wersją, aby klienci mogli uzyskać wczesny dostęp i przekazać opinię.

Wykonuje temat programu Microsoft Copilot Studio na podstawie zarejestrowanej nazwy zdarzenia. Zwraca tablicę typu MCSResponse.

Składnia

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

Parametry

Nazwa parametru Typ Wymagane Description
eventName ciąg Tak Nazwa zdarzenia zarejestrowana w temacie Microsoft Copilot Studio
eventParameters Unknown Tak Parametry wymagane do wykonania zdarzenia. Zależą one od tego, co robi temat.
successCallback Funkcja Tak Funkcja do wywołania, gdy operacja zakończy się pomyślnie.
errorCallback Funkcja Tak Funkcja wywoływana, gdy operacja zakończy się niepowodzeniem.

Wartość zwracana

Tablica mcSResponse

Uzyskiwanie dostępu do kontekstu aplikacji

Po wywołaniu interfejsu API agenta kontekst aplikacji jest przekazywany do tematu Copilot Studio za pośrednictwem zestawu zmiennych. Poniżej przedstawiono zmienne kontekstowe dostępne jako Copilot Studio – zmienne globalne.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid Identyfikator rekordu tabeli w formularzu głównym
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logiczna nazwa tabeli na stronie głównej
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nazwa strony głównej
Global.PA__Copilot_Model_PageContext.pageContext.pageType Typ strony głównej
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Unikalna nazwa aplikacji opartej na modelu

Na przykład przy użyciu i Global.PA__Copilot_Model_PageContext.pageContext.id.guidGlobal.PA__Copilot_Model_PageContext.pageContext.entityTypeNamemożna pobrać rekord formularza z usługi Dataverse.

Uzyskiwanie dostępu do parametrów zdarzeń

W temacie eventParameters Copilot Studio dostęp do wywołania interfejsu API można uzyskać przy użyciu zmiennej Activity.Value. Użyj węzła Wartości analizy , aby przekonwertować kod JSON na rekord z co najmniej jednym polem. Wybranie pozycji Z przykładowych danych dla pozycji Typ danych umożliwia udostępnienie przykładu JSON do utworzenia rekordu.

Example

W programie Microsoft Copilot Studio, w którym zarejestrowano temat, który akceptuje identyfikator (identyfikator rekordu jednostki) jako parametr wejściowy. Na podstawie danych wejściowych pobiera powiązane działania tego rekordu jednostki i zwraca wyniki jako działanie zdarzenia Copilot Studio.

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

Odpowiedź

[
    {
        "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 (dokumentacja interfejsu API klienta)

  • Last updated on