Aracılığıyla paylaş

executeEvent (İstemci API başvurusu) (önizleme)

Önemli

  • Bu bir önizleme özelliğidir.
  • Önizleme özellikleri, üretimde kullanıma yönelik değildir ve sınırlı işlevselliğe sahip olabilir. Bu özellikler, ek kullanım koşullarına tabidir ve müşterilerin önceden erişmesi ve geri bildirim sağlaması amacıyla resmi sürümden önce kullanıma sunulur.

Kayıtlı Olay Adını temel alan bir Microsoft Copilot Studio konusu yürütür. MCSResponse türünde bir dizi döndürür.

Sözdizimi

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

Parametreler

Parametre Adı Türü Gerekli Description
eventName String Yes Microsoft Copilot Studio konusuna kaydedilen Olay Adı
eventParameters Bilinmiyor Yes Olay yürütme için gereken parametreler. Bunlar, konunun ne yaptığına bağlıdır.
successCallback İşlev Yes İşlem başarılı olduğunda çağrılacak bir işlev.
errorCallback İşlev Yes İşlem başarısız olduğunda çağrılacak bir işlev.

Dönüş Değeri

BIR MCSResponse dizisi

Uygulama bağlamına erişme

Aracı API'leri çağrıldığında, uygulamanın bağlamı bir dizi değişken aracılığıyla Copilot Studio konusuna geçirilir. Aşağıda Copilot Studio global değişken olarak kullanılabilen bağlam değişkenleri bulunmaktadır.

Variable Description
Global.PA__Copilot_Model_PageContext.pageContext.id.guid Ana formdaki tablo kaydının kimliği
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Ana sayfadaki tablonun mantıksal adı
Global.PA__Copilot_Model_PageContext.pageContext.pageName Ana sayfanın adı
Global.PA__Copilot_Model_PageContext.pageContext.pageType Ana sayfanın türü
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Model odaklı uygulamanın benzersiz adı

Örneğin ve kullanarak Global.PA__Copilot_Model_PageContext.pageContext.id.guidGlobal.PA__Copilot_Model_PageContext.pageContext.entityTypeNameformun kaydı Dataverse'den alınabilir.

eventParameters'a erişme

Copilot Studio konusunda API eventParameters çağrısından öğesine değişkeni Activity.Valuekullanılarak erişilebilir. JSON'ı bir veya daha fazla alanı olan bir kayda dönüştürmek için Ayrıştır değer düğümünü kullanın. Veri türü için Örnek verilerden seçeneğinin seçilmesi, kaydı oluşturmak için bir JSON örneği sağlanmasına olanak tanır.

Example

Giriş parametresi olarak kimlik (varlık kaydı kimliği) kabul eden bir konunun kaydedildiği Microsoft Copilot Studio'da. Girişe bağlı olarak, bu varlık kaydının ilgili etkinliklerini alır ve sonuçları Copilot Studio olay etkinliği olarak döndürür.

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

Yanıt

[
    {
        "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 (İstemci API başvurusu)

  • Last updated on