Partajați prin

executeEvent (Referință API client) (previzualizare)

Important

  • Aceasta este o caracteristică de previzualizare.
  • Caracteristicile în regim de previzualizare nu sunt destinate utilizării în producție și pot avea funcționalități restricționate. Aceste funcții sunt supuse termenilor de utilizare suplimentari și sunt disponibile înainte de o lansare oficială, astfel încât clienții să poată avea acces anticipat și să poată oferi feedback.

Execută un subiect Microsoft Copilot Studio pe baza numelui de eveniment înregistrat. Returnează o matrice de tip MCSResponse.

Sintaxă

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

Parametri

Nume parametru Tip Obligatoriu Descriere
eventName string Da Numele evenimentului înregistrat în subiectul Microsoft Copilot Studio
eventParameters Necunoscut Da Parametri necesari pentru executarea evenimentului. Acestea depind de ceea ce face subiectul.
successCallback Function Da O funcție de apelat atunci când operațiunea reușește.
errorCallback Function Da O funcție de apelat atunci când operațiunea eșuează.

Valoarea returnată

O matrice de MCSResponse

Accesarea contextului aplicației

Atunci când se apelează un API agent, contextul pentru aplicație este transmis subiectului Copilot Studio printr-un set de variabile. Iată variabilele contextuale disponibile ca variabile globale Copilot Studio.

Variabilă Descriere
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID-ul înregistrării tabel din formularul principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Numele logic al tabelului din pagina principală
Global.PA__Copilot_Model_PageContext.pageContext.pageName Numele paginii principale
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipul paginii principale
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Numele unic al aplicației bazate pe modele

De exemplu, utilizarea Global.PA__Copilot_Model_PageContext.pageContext.id.guid și Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, înregistrarea formularului poate fi regăsită din Dataverse.

Accesarea eventParameters

În cadrul subiectului Copilot Studio, apelul eventParameters API poate fi accesat utilizând variabila Activity.Value. Utilizați nodul de valori de analiză pentru a efectua conversia JSON într-o înregistrare cu unul sau mai multe câmpuri. Selectarea De la date eșantion pentru tipul de date permite furnizarea unui exemplu JSON pentru a crea înregistrarea.

Exemplu

În Microsoft Copilot Studio, unde este înregistrat un subiect care acceptă un ID (ID înregistrare entitate) ca parametru de intrare. Pe baza introducerii, regăsește activitățile asociate ale înregistrării entității respective și returnează rezultatele ca activitate de eveniment Copilot Studio.

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

Response

[
    {
        "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 (referință API client)

  • Last updated on