Condividi tramite

executeEvent (informazioni di riferimento sulle API client) (anteprima)

Importante

  • Si tratta di una funzionalità di anteprima.
  • Le funzionalità di anteprima non sono destinate ad essere utilizzate per la produzione e sono soggette a restrizioni. Queste funzionalità sono soggette a condizioni per l'utilizzo supplementari e sono disponibili prima di una versione ufficiale in modo che i clienti possano ottenere l'accesso iniziale e fornire feedback.

Esegue un argomento di Microsoft Copilot Studio basato sul nome dell'evento registrato. Restituisce una matrice di tipo MCSResponse.

Sintassi

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

Parametri

Nome del parametro TIPO Obbligatorio Description
eventName corda Yes Nome evento registrato nell'argomento Microsoft Copilot Studio
eventParameters Sconosciuto Yes Parametri necessari per l'esecuzione dell'evento. Questi dipendono da ciò che fa l'argomento.
successCallback Funzione Yes Funzione da chiamare quando l'operazione ha esito positivo.
errorCallback Funzione Yes Funzione da chiamare quando l'operazione ha esito negativo.

Valore restituito

Matrice di MCSResponse

Accesso al contesto dell'app

Quando viene chiamata un'API agent, il contesto per l'app viene passato all'argomento Copilot Studio tramite un set di variabili. Di seguito sono riportate le variabili di contesto disponibili come Variabili globali di Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID del record della tabella nel modulo principale
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nome logico della tabella nella pagina principale
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nome della pagina principale
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipo di pagina principale
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nome univoco dell'app basata su modelli

Ad esempio, usando Global.PA__Copilot_Model_PageContext.pageContext.id.guid e Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, il record del modulo può essere recuperato da Dataverse.

Accesso a eventParameters

All'interno dell'argomento Copilot Studio, è eventParameters possibile accedere alla chiamata API usando la variabile Activity.Value. Usare Il nodo Parse value (Analizza valore) per convertire il codice JSON in un record con uno o più campi. Se si seleziona Da dati di esempio per Tipo di dati , è possibile fornire un esempio JSON per creare il record.

Example

In Microsoft Copilot Studio, in cui viene registrato un argomento che accetta un ID (ID record di entità) come parametro di input. In base all'input, recupera le attività correlate del record di entità e restituisce i risultati come attività evento di Copilot Studio.

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

Risposta

[
    {
        "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 (Informazioni di riferimento sulle API client)

  • Last updated on