Compartir por

executeEvent (Client API reference) (preview)

Importante

  • Esta é unha funcionalidade de vista previa.
  • As funcionalidades en versión preliminar non están destinadas a usarse en produción e poderían ter restrinxida a funcionalidade. Estas funcionalidades están suxeitas a *condicións de uso suplementarias* e están dispoñibles antes do lanzamento oficial para que os clientes poidan obter acceso anticipado e proporcionar comentarios. ...

Executa un tema de Microsoft Copilot Studio baseado no nome do evento rexistrado. Devolve unha matriz de tipo MCSResponse.

Sintaxe

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

Parámetros

Nome do parámetro Tipo Obrigatorio Descrición
eventName cadea Si Nome do evento rexistrado no tema de Microsoft Copilot Studio
eventParameters Descoñecido Si Parámetros necesarios para a execución do evento. Isto depende do que faga o tema.
successCallback Function Si Unha función a chamar cando a operación teña éxito.
errorCallback Function Si Unha función a chamar cando a operación falla.

Valor devolto

Un array de MCSResponse

Accedendo ao contexto da aplicación

Cando se chama a unha API de axente, o contexto da aplicación pasa ao tema de Copilot Studio a través dun conxunto de variables. As seguintes son variables de contexto dispoñibles como Copilot Studio variables globais.

Variable Descrición
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID do rexistro da táboa no formulario principal
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nome lóxico da táboa na páxina principal
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nome da páxina principal
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipo de páxina principal
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nome único da aplicación baseada en modelos

Por exemplo, usando Global.PA__Copilot_Model_PageContext.pageContext.id.guid e Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, o rexistro do formulario pódese recuperar de Dataverse.

Acceder aos parámetros de eventos

Dentro do tema Copilot Studio, pódese acceder á eventParameters chamada desde a API usando a variable Activity.Value. Usar o nodo de valor de análise para converter o JSON nun rexistro cun ou máis campos. Seleccionar De datos de mostra para Tipo de datos permite proporcionar un exemplo JSON para crear o rexistro.

Exemplo

En Microsoft Copilot Studio, onde se rexistra un tema que acepta un ID (ID de rexistro de entidade) como parámetro de entrada. En función da entrada, recupera as actividades relacionadas dese rexistro de entidade e devolve os resultados como unha actividade de evento de 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 (Referencia da API do cliente)

  • Last updated on