Изменить

Поделиться через

executeEvent (preview)

Important

  • This is a preview feature.
  • Preview features aren’t meant for production use and might have restricted functionality. These features are subject to supplemental terms of use, and are available before an official release so that customers can get early access and provide feedback.

Executes a Microsoft Copilot Studio topic based on the registered Event Name. Returns an array of type MCSResponse.

Available for

Model-driven apps

Syntax

context.copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Parameters

Parameter Name Type Required Description
eventName string Yes Event Name registered in the Copilot Studio topic
eventParameters Unknown Yes Parameters needed for the event execution. These depend on what the topic does.
successCallback Function Yes A function to call when the operation succeeds.
errorCallback Function Yes A function to call when the operation fails.

Return Value

Type: Promise<MCSResponse>

See Promise and MCSResponse

Accessing app context

When an Agent API is called, context for the app is passed to the Copilot Studio topic through a set of variables. The following are context variables available as Copilot Studio global variables.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID of the table record on the main form
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Logical name of the table in the main page
Global.PA__Copilot_Model_PageContext.pageContext.pageName Name of the main page
Global.PA__Copilot_Model_PageContext.pageContext.pageType Type of the main page
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Unique name of the model-driven app

For example, using Global.PA__Copilot_Model_PageContext.pageContext.id.guid and Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, the form's record can be retrieved from Dataverse.

Accessing eventParameters

Within the Copilot Studio topic, the eventParameters from the API call can be accessed using the variable Activity.Value. Use Parse value node to convert the JSON into a record with one or more fields. Selecting From sample data for Data type allows providing a JSON example to create the record.

Example

In Microsoft Copilot Studio, where a topic is registered that accepts an ID (entity record ID) as an input parameter. Based on the input, it retrieves the related activities of that entity record and returns the results as an Copilot Studio event activity. The PCF context API enables the execution of these methods within the context of PCF controls.

const response = await context.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"
    }
]

Copilot
executePrompt
Power Apps component framework API reference
Power Apps component framework overview