Bagikan melalui

executeEvent (Referensi API Klien) (pratinjau)

Penting

  • Ini adalah fitur pratinjau.
  • Fitur pratinjau tidak dimaksudkan untuk digunakan dalam produksi dan fungsinya mungkin terbatas. Fitur-fitur ini tunduk pada ketentuan penggunaan tambahan, dan tersedia sebelum rilis resmi sehingga pelanggan dapat memperoleh akses awal dan memberikan umpan balik.

Menjalankan topik Microsoft Copilot Studio berdasarkan Nama Peristiwa terdaftar. Mengembalikan array jenis MCSResponse.

Syntax

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

Parameter-parameternya

Nama Parameter Tipe Diperlukan Description
eventName string Yes Nama Peristiwa yang terdaftar dalam topik Microsoft Copilot Studio
eventParameters Unknown Yes Parameter yang diperlukan untuk eksekusi peristiwa. Ini tergantung pada apa yang dilakukan topik.
successCallback Function Yes Fungsi untuk memanggil saat operasi berhasil.
errorCallback Function Yes Fungsi untuk memanggil saat operasi gagal.

Mengembalikan Nilai

Array MCSResponse

Mengakses konteks aplikasi

Saat API Agen dipanggil, konteks untuk aplikasi diteruskan ke topik Copilot Studio melalui serangkaian variabel. Berikut ini adalah variabel konteks yang tersedia sebagai variabel global Copilot Studio.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid ID rekaman tabel pada formulir utama
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Nama logika tabel di halaman utama
Global.PA__Copilot_Model_PageContext.pageContext.pageName Nama halaman utama
Global.PA__Copilot_Model_PageContext.pageContext.pageType Tipe halaman utama
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Nama unik aplikasi berbasis model

Misalnya, menggunakan Global.PA__Copilot_Model_PageContext.pageContext.id.guid dan Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, rekaman formulir dapat diambil dari Dataverse.

Mengakses eventParameters

Dalam topik Copilot Studio, eventParameters dari panggilan API dapat diakses menggunakan variabel Activity.Value. Gunakan simpul nilai Parse untuk mengonversi JSON menjadi rekaman dengan satu atau beberapa bidang. Memilih Dari data sampel untuk Jenis data memungkinkan penyediaan contoh JSON untuk membuat rekaman.

Example

Di Microsoft Copilot Studio, tempat topik terdaftar yang menerima ID (ID rekaman entitas) sebagai parameter input. Berdasarkan input, ia mengambil aktivitas terkait dari rekaman entitas tersebut dan mengembalikan hasilnya sebagai aktivitas peristiwa Copilot Studio.

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

Jawaban

[
    {
        "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 (Referensi API Klien)

  • Last updated on