Üretken sayfalar için bağlayıcı yöntemleri

Sayfaya bağlı bir Power Platform bağlayıcısı dataApi tarafından kullanıma sunulan verilerle çalışmak için nesnenin bağlayıcı yöntemlerini kullanın.

Uyarı

Bağlayıcı yöntemleri paylaşılan dataApi sözleşmede isteğe bağlıdır. Bazı konaklar bunları uygulamaz, bu nedenle çağırmadan önce bir yöntemin mevcut olup olmadığını denetleyin. Bir yöntemin mevcut olması, sayfanın ona bağlı bir bağlayıcısı olduğu veya bağlantının, veri kümesinin, tablonun veya işlemin beklendiği gibi yapılandırıldığı, yetkilendirildiği veya izin verildiği anlamına gelmez.

Eylem ve işlev yöntemlerinden farklı olarak, bağlayıcı yöntemleri bir çağrı başarısız olduğunda döndürülen sözü reddeder. Örneğin, bağlantı başvurusu çözümlenemediğinde bağlantı yetkilendirilmez ve kullanıcı onay istemini tamamlamaz veya bağlayıcı bir hata durumu döndürür. executeConnectorOperation hata durumlarının çoğu için ile ok: false çözümlenir, ancak yine de eksik bir işlem, tamamlanmış onay olmadan yetkisiz bağlantı (403) veya aktarım hatası için reddeder. içinde bağlayıcı çağrılarını try/catchsarmalama.

Method	Description
createConnectorRow	Belirtilen bağlayıcı tablosunda yeni bir satır oluşturur.
deleteConnectorRow	Belirtilen bağlayıcı tablosundan bir satırı siler.
executeConnectorOperation	rest (operation-keyed) bağlayıcısı tarafından kullanıma sunulan Office 365 Kullanıcıları gibi adlandırılmış bir işlemi çağırır.
getConnectorSwagger	Bağlayıcı için Swagger (OpenAPI) tanımını alır.
getConnectorTableSchema	Bağlayıcı tarafından kullanıma sunulan bir tablonun (varlık veya liste olarak da adlandırılır) şemasını alır.
listConnectorDatasets	Bağlayıcı için kullanılabilen veri kümelerini listeler.
listConnectorOperations	REST (operation-keyed) bağlayıcısı tarafından kullanıma sunulan işlemleri listeler.
listConnectorTables	Belirtilen bağlayıcı veri kümesinde kullanılabilen tabloları listeler.
queryConnectorTable	Bağlayıcı tarafından sunulan bir tabloyu belirtilen seçeneklerle sorgular.
retrieveConnectorRow	Belirtilen bağlayıcı tablosundan tek bir satır alır.
updateConnectorRow	Belirtilen bağlayıcı tablosundaki mevcut bir satırı güncelleştirir.

queryConnectorTable yöntemi

Belirtilen seçenekleri kullanarak bağlayıcı tarafından kullanıma sunulan bir tabloyu sorgular.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı (örneğin, sp_shared_sharepointonline).
dataset	string	SharePoint site URL'si gibi tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.
options	QueryConnectorTableOptions	Tabloyu sorgulama seçenekleri.

QueryConnectorTableOptions

Name	Type	Description
select	string[]	(Önerilen) Alınacak sütun adları dizisi.
filter	string	(İsteğe bağlı) Bağlayıcı tarafından desteklenen filtre ifadesi.
orderBy	string	(İsteğe bağlı) Bağlayıcı tarafından desteklenen sıralama ölçütü ifadesi.
top	number	(İsteğe bağlı) Döndürülecek en fazla satır sayısı.

Returns

İşlemin sonucunu içeren bir söz . İşlem başarılı olduğunda, promise şu özelliklere sahip sonuçları içeren bir veri tablosu içeren bir nesne döndürür:

Name	Type	Description
rows	Object[]	Satır verileri dizisi.
hasMoreRows	boolean	Kullanılabilir daha fazla satır olup olmadığını gösterir.

queryConnectorTable tek bir sonuç sayfası döndürür. Bir devamlılık işlevi döndürmez ve şu anda bir sonraki sayfayı getirmenin desteklenen bir yolu yoktur. olduğunda hasMoreRowstrue, döndürülenden daha fazla satır eşleştirilir. ile sorguyu filterdaraltın veya kullanıcıya sonuçların eksik olduğunu söyleyin.

queryConnectorTable örneği

if (!dataApi.listConnectorTables || !dataApi.queryConnectorTable) {
  throw new Error("Connector methods aren't available on this page.");
}

const tables = await dataApi.listConnectorTables(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing"
);
const documentsTable = tables.find((table) => table.displayName === "Documents");
if (!documentsTable) {
  throw new Error("The Documents table wasn't found in this dataset.");
}
const documentsTableName = documentsTable.name;

const result = await dataApi.queryConnectorTable(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName,
  {
    select: ["Title", "Modified"],
    top: 50,
  }
);

Aşağıdaki örneklerde, yukarıda gösterildiği gibi tablosundan listConnectorTablesdeğerlerin name bulunduğu varsayılırdocumentsTableName.

listConnectorTables yöntemi

Belirtilen bağlayıcı veri kümesinde kullanılabilen tabloları (listeler veya varlıklar) listeler.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tablo listesi için veri kümesi.

Returns

Tablo bilgileri dizisi içeren bir söz . Her girdi şu özelliklere sahiptir:

Name	Type	Description
name	string	Tablonun iç adı.
displayName	string	Tablonun görünen adı.

listConnectorTables örneği

const tables = await dataApi.listConnectorTables?.(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing"
);

listConnectorDatasets yöntemi

Bağlantının erişebileceği SharePoint siteler gibi bağlayıcı için kullanılabilir veri kümelerini listeler.

Parameters

Bu gerekli parametre için bir değer ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.

Returns

Veri kümesi bilgileri dizisi içeren bir söz . Her girdi şu özelliklere sahiptir:

Name	Type	Description
name	string	Veri kümesinin iç adı veya tanımlayıcısı.
displayName	string	Veri kümesinin görünen adı.

listConnectorDatasets örneği

const datasets = await dataApi.listConnectorDatasets?.("sp_shared_sharepointonline");

listConnectorOperations yöntemi

Bağlayıcının Swagger tanımında tanımlanan ve dahili olarak işaretlenen işlemler hariç, görünen ada göre sıralanmış işlemleri listeler. Bu yöntem en çok Office 365 Kullanıcıları gibi REST (işlem anahtarlı) bağlayıcılar için kullanışlıdır. Tablosal bağlayıcılar için, bu yöntemin listeledikleri işlemler yerine sorgu ve satır yöntemlerini kullanın.

Parameters

Bu gerekli parametre için bir değer ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.

Returns

İşlem bilgileri dizisi içeren bir söz . Her girdi şu özelliklere sahiptir:

Name	Type	Description
name	string	Bağlayıcının Swagger tanımında tanımlanan işlem kimliği. Bu değeri öğesine executeConnectorOperationgeçirin.
displayName	string	Swagger özeti gibi görüntüleme için okunabilir işlem adı. Özet tanımlanmadıysa geri döner name .

listConnectorOperations örneği

const operations = await dataApi.listConnectorOperations?.("sp_shared_sharepointonline");

getConnectorSwagger yöntemi

Bağlayıcının kullanıma sunmuş olduğu işlemleri açıklayan Swagger (OpenAPI) tanımını alır. Döndürülen belge, bağlayıcıyı genel olarak açıklar. Tablo bağlayıcıları için tablo başına sütun şemaları içermez. Bu bilgiler için kullanın getConnectorTableSchema .

Parameters

Bu gerekli parametre için bir değer ayarlayın.

Name	Type	Description
connectorApiId	string	Gibi /providers/Microsoft.PowerApps/apis/shared_sharepointonlinebağlayıcı API'sinin tanımlayıcısı. Bu tanımlayıcı, diğer bağlayıcı yöntemlerinin çoğu tarafından kullanılan bağlantı başvurusu mantıksal adından (connectorLogicalName) farklıdır.

Returns

Bağlayıcının Swagger tanımını nesne olarak içeren bir söz .

getConnectorSwagger örneği

if (!dataApi.getConnectorSwagger) {
  throw new Error("getConnectorSwagger isn't available on this page.");
}

const swagger = await dataApi.getConnectorSwagger(
  "/providers/Microsoft.PowerApps/apis/shared_sharepointonline"
);

getConnectorTableSchema yöntemi

Bağlayıcı tarafından kullanıma sunulan bir tablo için şemayı (sütun tanımları) alır. Bağlayıcı, döndürdüğü şemayı tanımlar ve bağlayıcıya göre değişir. Tablonun içerebileceği her dinamik sütunu içerdiğini varsaymayın.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.

Returns

Tablo şemasını nesne olarak içeren bir söz .

getConnectorTableSchema örneği

if (!dataApi.getConnectorTableSchema) {
  throw new Error("getConnectorTableSchema isn't available on this page.");
}

const schema = await dataApi.getConnectorTableSchema(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName // from listConnectorTables
);

retrieveConnectorRow yöntemi

Belirtilen bağlayıcı tablosundan tek bir satır alır.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.
id	string	Alınacak satırın kimliği.
options	RetrieveConnectorRowOptions	(İsteğe bağlı) Satırı alma seçenekleri.

RetrieveConnectorRowOptions

Name	Type	Description
select	string[]	(Önerilen) Alınacak sütun adları dizisi. Atlanırsa projeksiyon $select gönderilmez; bağlayıcı hangi sütunların döndürüleceğini belirler ve satırdaki her sütunu döndürmeyi garanti etmez.

Returns

Satır verilerini içeren bir söz .

retrieveConnectorRow örneği

if (!dataApi.retrieveConnectorRow) {
  throw new Error("retrieveConnectorRow isn't available on this page.");
}

const row = await dataApi.retrieveConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1"
);

createConnectorRow yöntemi

Belirtilen bağlayıcı tablosunda yeni bir satır oluşturur.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.
row	object	Oluşturulacak satır verileri.

Returns

Varsa bağlayıcı tarafından döndürülen yanıt gövdesini içeren bir söz . Bağlayıcıya bağlı olarak, bu değer oluşturulan satır, kısmi satır veya değer yok olabilir.

createConnectorRow örneği

if (!dataApi.createConnectorRow) {
  throw new Error("createConnectorRow isn't available on this page.");
}

const newRow = await dataApi.createConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  { Title: "New document" }
);

updateConnectorRow yöntemi

Belirtilen bağlayıcı tablosundaki mevcut bir satırı güncelleştirir.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.
id	string	Güncelleştirilecek satırın kimliği.
row	object	Güncelleştirilecek satır verileri.

Returns

Varsa bağlayıcı tarafından döndürülen yanıt gövdesini içeren bir söz . Bağlayıcıya bağlı olarak, bu değer güncelleştirilmiş satır, kısmi satır veya değer yok olabilir. Satırın geçerli değerlerini okumak için öğesini çağırın retrieveConnectorRow.

updateConnectorRow örneği

if (!dataApi.updateConnectorRow) {
  throw new Error("updateConnectorRow isn't available on this page.");
}

const updatedRow = await dataApi.updateConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1",
  { Title: "Updated title" }
);

deleteConnectorRow yöntemi

Belirtilen bağlayıcı tablosundan bir satırı siler.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
dataset	string	Tabloyu içeren veri kümesi.
tableName	string	tarafından listConnectorTablesdöndürülen özelliğinden name tablonun iç adı. Görünen adı kullanmayın.
id	string	Silinecek satırın kimliği.

Returns

İşlemin sonucunu içeren bir söz . İşlem başarılı olduğunda değer döndürmez.

deleteConnectorRow örneği

if (!dataApi.deleteConnectorRow) {
  throw new Error("deleteConnectorRow isn't available on this page.");
}

await dataApi.deleteConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1"
);

executeConnectorOperation yöntemi

HTTP, Teams ileti gönderme veya Office 365 Kullanıcıları gibi rest (işlem anahtarlı) bağlayıcısı tarafından kullanıma sunulan adlandırılmış işlemi çağırır. Tablo bağlayıcıları bunun yerine sorgu ve satır CRUD yöntemlerini kullanmalıdır.

Parameters

Bu gerekli parametreler için değerleri ayarlayın.

Name	Type	Description
connectorLogicalName	string	Sayfaya bağlı bağlantı başvurusunun mantıksal adı.
operationName	string	Bağlayıcının Swagger tanımında tanımlanan işlem kimliği.
parameters	object	İşlemin gerektirdiği parametreler. İşlem parametre almazsa boş bir nesne ({}) geçirin; gönderilecek hiçbir şey olmadığında bile bu parametre gereklidir.

Returns

Bu özelliklere sahip işlem sonucunu içeren bir söz . Bağlantı başvurusu çözümlenemiyorsa, bağlayıcının Swagger tanımı alınamıyorsa, işlem içinde bulunamıyorsa, çağrı gönderilemiyorsa veya bağlantı yetkilendirilmediğinde (HTTP 403) ve kullanıcı bağlantı onayı istemini tamamlamazsa söz reddedilir.

Name	Type	Description
ok	boolean	true temel http durumu 400'den küçük olduğunda. Bu durum yeniden yönlendirme (3xx) durumlarını içerir, bu nedenle tek başına döndürülen işlem verilerinin kanıtı olarak işlem ok yapmayın; ayrıca denetleyin status veya inceleyin body.
status	number	Bağlayıcı tarafından döndürülen ham HTTP durum kodu.
body	unknown	Ayrıştırılmış JSON yanıt gövdesi veya gövde JSON değilse ham dize.

executeConnectorOperation örneği

Aşağıdaki örnekte ve destinationUrl parametrelerini kabul sourceUrl eden adlı CopyFile bir işlem varsayılır. Kullanılabilir işlemler ve parametreleri bağlayıcıya göre farklılık gösterdiğinden, işlem kimliğini ve parametrelerini kullanmadan önce bağlayıcının kendi Swagger tanımına (örneğin, veya getConnectorSwaggerilelistConnectorOperations) karşı doğrulayın.

if (!dataApi.executeConnectorOperation) {
  throw new Error("executeConnectorOperation isn't available on this page.");
}

try {
  const result = await dataApi.executeConnectorOperation(
    "sp_shared_sharepointonline",
    "CopyFile",
    { sourceUrl: "/sites/Marketing/Shared Documents/file.docx", destinationUrl: "/sites/Sales/Shared Documents/file.docx" }
  );

  if (result.ok) {
    console.log(result.body);
  }
  else {
    console.log(result.status);
  }
}
catch (error) {
  console.log(error);
}