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

executeEvent (довідник із API клієнта) (підготовча версія)

Важливо

  • Це функція попереднього перегляду.
  • Підготовчі функції призначені для невиробничого використання. Їх можливості можуть бути обмеженими. Ці функції регулюються додатковими умовами використання та доступні перед офіційним випуском, щоб клієнти могли отримати ранній доступ і залишити відгук.

Виконує розділ Microsoft Copilot Studio на основі зареєстрованого імені події. Повертає масив типу MCSResponse.

Синтаксис

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

Параметри

Найменування параметра Тип Обов'язковий Опис
eventName рядок Так Назва події, зареєстрована в статті Microsoft Copilot Studio
eventParameters Невідомий Так Параметри, необхідні для виконання події. Вони залежать від того, що робить тема.
successCallback Function Так Функція для виклику в разі успіху операції.
errorCallback Function Так Функція для виклику, коли операція не вдається.

Повернуте значення

Масив MCSResponse

Доступ до контексту застосунку

Коли викликається API агента, контекст програми передається до теми Copilot Studio через набір змінних. Нижче наведено контекстні змінні, доступні як Copilot Studio глобальні змінні.

Змінна Опис
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID запису таблиці на головній формі
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Логічна назва таблиці на головній сторінці
Global.PA__Copilot_Model_PageContext.pageContext.pageName Назва головної сторінки
Global.PA__Copilot_Model_PageContext.pageContext.pageType Тип головної сторінки
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Унікальна назва додатка на основі моделі

Наприклад, за допомогою Global.PA__Copilot_Model_PageContext.pageContext.id.guid та Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, запис форми можна отримати з Dataverse.

Доступ до подійПараметри

У розділі eventParameters Copilot Studio виклик API можна отримати за допомогою змінної Activity.Value. Щоб перетворити JSON на запис з одним або кількома полями, скористайтеся вузлом аналізу значень . Вибір зі зразка даних для типу даних дає змогу створити запис у прикладі JSON.

Приклад

У Microsoft Copilot Studio, де зареєстровано тему, яка приймає ідентифікатор (ідентифікатор запису сутності) як вхідний параметр. Залежно від введених даних, він отримує пов'язані дії цього запису сутності та повертає результати як активність події 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 (довідник з API клієнта)

  • Last updated on