जनरेटिव पृष्ठों के लिए कनेक्टर विधियाँ

पृष्ठ पर बाध्य Power Platform कनेक्टर द्वारा उजागर डेटा के साथ कार्य करने के लिए ऑब्जेक्ट की कनेक्टर dataApi विधियों का उपयोग करें.

नोट

साझा dataApi अनुबंध में कनेक्टर विधियाँ वैकल्पिक हैं। कुछ होस्ट उन्हें लागू नहीं करते हैं, इसलिए इसे कॉल करने से पहले जांच लें कि कोई विधि मौजूद है। एक विधि मौजूद होने का मतलब यह नहीं है कि पृष्ठ में एक कनेक्टर बंधा हुआ है, या यह कि कनेक्शन, डेटासेट, तालिका या कार्रवाई कॉन्फ़िगर किया गया है, अधिकृत है, या अपेक्षा के अनुरूप अनुमति दी गई है।

कार्रवाई और फ़ंक्शन विधियों के विपरीत, कनेक्टर विधियां कॉल विफल होने पर लौटाए गए वादे को अस्वीकार कर देती हैं - उदाहरण के लिए, जब कनेक्शन संदर्भ हल नहीं किया जा सकता है, तो कनेक्शन अधिकृत नहीं होता है और उपयोगकर्ता सहमति संकेत को पूरा नहीं करता है, या कनेक्टर एक त्रुटि स्थिति लौटाता है। executeConnectorOperation अधिकांश त्रुटि स्थितियों के साथ हल ok: false करता है, लेकिन फिर भी एक अनुपलब्ध ऑपरेशन के लिए अस्वीकार करता है, पूर्ण सहमति के बिना एक अनधिकृत कनेक्शन (403), या एक परिवहन विफलता। रैप कनेक्टर कॉल करता है try/catch।

विधि	विवरण
createConnectorRow	निर्दिष्ट कनेक्टर तालिका में एक नई पंक्ति बनाता है।
deleteConnectorRow	निर्दिष्ट कनेक्टर तालिका से कोई पंक्ति हटाता है.
executeConnectorOperation	किसी REST (ऑपरेशन-कीड) कनेक्टर, जैसे Office 365 Users द्वारा प्रदर्शित नामित कार्रवाई को प्रारंभ करता है.
getConnectorSwagger	कनेक्टर के लिए स्वैगर (OpenAPI) परिभाषा पुनर्प्राप्त करता है।
getConnectorTableSchema	कनेक्टर द्वारा उजागर की गई तालिका (जिसे निकाय या सूची भी कहा जाता है) के लिए स्कीमा पुनर्प्राप्त करता है.
listConnectorDatasets	कनेक्टर के लिए उपलब्ध डेटासेट को सूचीबद्ध करता है।
listConnectorOperations	REST (ऑपरेशन-कुंजी) कनेक्टर द्वारा उजागर की गई कार्रवाइयों को सूचीबद्ध करता है।
listConnectorTables	निर्दिष्ट कनेक्टर डेटासेट में उपलब्ध तालिकाओं को सूचीबद्ध करता है.
queryConnectorTable	निर्दिष्ट विकल्पों के साथ कनेक्टर द्वारा उजागर की गई तालिका को क्वेरी करता है।
retrieveConnectorRow	निर्दिष्ट कनेक्टर तालिका से एक पंक्ति पुनर्प्राप्त करता है।
updateConnectorRow	निर्दिष्ट कनेक्टर तालिका में किसी मौजूदा पंक्ति को अद्यतन करता है.

queryConnectorTable विधि

निर्दिष्ट विकल्पों का उपयोग करके कनेक्टर द्वारा प्रदर्शित तालिका को क्वेरीज़ करता है।

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम (उदाहरण के लिए, sp_shared_sharepointonline).
dataset	string	वह डेटासेट जिसमें तालिका होती है, जैसे कोई SharePoint साइट URL.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।
options	QueryConnectorTableOptions	तालिका को क्वेरी करने के विकल्प.

QueryConnectorTableOptions

नाम	प्रकार	विवरण
select	string[]	(सिफारिश की) पुनः प्राप्त करने के लिए स्तंभ नामों की सरणी।
filter	string	(वैकल्पिक) कनेक्टर द्वारा समर्थित फ़िल्टर अभिव्यक्ति।
orderBy	string	(वैकल्पिक) कनेक्टर द्वारा समर्थित ऑर्डर-बाय एक्सप्रेशन।
top	number	(वैकल्पिक) वापस लौटने के लिए पंक्तियों की अधिकतम संख्या।

वापस

ऑपरेशन के परिणाम वाला एक वादा। जब ऑपरेशन सफल होता है, तो वादा इन गुणों के परिणामों के साथ डेटा तालिका वाली ऑब्जेक्ट लौटाता है:

नाम	प्रकार	विवरण
rows	Object[]	पंक्ति डेटा की सरणी।
hasMoreRows	boolean	इंगित करता है कि क्या अधिक पंक्तियाँ उपलब्ध हैं।

queryConnectorTable परिणामों का एक पृष्ठ लौटाता है. यह एक निरंतरता फ़ंक्शन वापस नहीं करता है, और वर्तमान में अगले पृष्ठ को लाने का कोई समर्थित तरीका नहीं है। कब hasMoreRows है true, लौटाए गए से अधिक पंक्तियाँ मेल खाती हैं। क्वेरी को इसके साथ filterसीमित करें, या उपयोगकर्ता को बताएं कि परिणाम अपूर्ण हैं।

queryConnectorTable उदाहरण

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,
  }
);

निम्नलिखित उदाहरण मानते हैं कि documentsTableName तालिका name से है listConnectorTables, जैसा कि ऊपर दिखाया गया है।

listConnectorTables विधि

निर्दिष्ट कनेक्टर डेटासेट में उपलब्ध तालिकाओं (सूचियों या निकायों) को सूचीबद्ध करता है.

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	के लिए तालिकाओं को सूचीबद्ध करने के लिए डेटासेट.

वापस

एक वादा जिसमें तालिका की जानकारी की एक सरणी होती है। प्रत्येक प्रविष्टि में ये गुण होते हैं:

नाम	प्रकार	विवरण
name	string	तालिका का आंतरिक नाम.
displayName	string	तालिका का प्रदर्शन नाम.

listConnectorTables उदाहरण

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

listConnectorDatasets विधि

कनेक्टर के लिए उपलब्ध डेटासेट को सूचीबद्ध करता है, जैसे कि कनेक्शन द्वारा एक्सेस किए जा सकने वाली SharePoint साइट्स को सूचीबद्ध करता है.

पैरामीटर

इस आवश्यक पैरामीटर के लिए कोई मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.

वापस

डेटासेट जानकारी की एक सरणी वाला वादा। प्रत्येक प्रविष्टि में ये गुण होते हैं:

नाम	प्रकार	विवरण
name	string	डेटासेट का आंतरिक नाम या पहचानकर्ता।
displayName	string	डेटासेट का प्रदर्शन नाम.

listConnectorDatasets उदाहरण

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

listConnectorOperations विधि

कनेक्टर की स्वैगर परिभाषा में परिभाषित कार्यों को सूचीबद्ध करता है, प्रदर्शन नाम द्वारा क्रमबद्ध आंतरिक चिह्नित कार्यों को छोड़कर। यह विधि REST (ऑपरेशन-कुंजी) कनेक्टर्स जैसे Office 365 Users के लिए सबसे उपयोगी है. सारणीबद्ध कनेक्टर्स के लिए, इस विधि द्वारा सूचीबद्ध कार्रवाइयों के बजाय क्वेरी और पंक्ति विधियों का उपयोग करें।

पैरामीटर

इस आवश्यक पैरामीटर के लिए कोई मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.

वापस

एक वादा जिसमें संचालन की जानकारी की एक सरणी होती है। प्रत्येक प्रविष्टि में ये गुण होते हैं:

नाम	प्रकार	विवरण
name	string	कनेक्टर की स्वैगर परिभाषा में परिभाषित ऑपरेशन आईडी। इस मान को पास executeConnectorOperationकरें।
displayName	string	प्रदर्शन के लिए मानव-पठनीय ऑपरेशन नाम, जैसे स्वैगर सारांश। यदि कोई सारांश परिभाषित नहीं किया गया है, तो वापस आ जाता name है।

listConnectorOperations उदाहरण

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

getConnectorSwagger विधि

कनेक्टर के लिए स्वैगर (OpenAPI) परिभाषा पुनर्प्राप्त करता है, जो इसके द्वारा उजागर किए जाने वाले कार्यों का वर्णन करता है। लौटाया गया दस्तावेज़ समग्र रूप से कनेक्टर का वर्णन करता है। इसमें सारणीबद्ध कनेक्टर्स के लिए प्रति-तालिका स्तंभ स्कीमा शामिल नहीं है। उस जानकारी के लिए उपयोग करें getConnectorTableSchema ।

पैरामीटर

इस आवश्यक पैरामीटर के लिए कोई मान सेट करें.

नाम	प्रकार	विवरण
connectorApiId	string	कनेक्टर API पहचानकर्ता, जैसे ./providers/Microsoft.PowerApps/apis/shared_sharepointonline यह पहचानकर्ता कनेक्शन संदर्भ तार्किक नाम ()connectorLogicalName से भिन्न है जिसका उपयोग अधिकांश अन्य कनेक्टर विधियों द्वारा किया जाता है।

वापस

एक वादा जिसमें एक ऑब्जेक्ट के रूप में कनेक्टर की स्वैगर परिभाषा शामिल है।

getConnectorSwagger उदाहरण

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 विधि

कनेक्टर द्वारा उजागर तालिका के लिए स्कीमा (स्तंभ परिभाषाएँ) पुनर्प्राप्त करता है। कनेक्टर उस स्कीमा को परिभाषित करता है जो वह लौटाता है, और यह कनेक्टर द्वारा भिन्न होता है। यह न मानें कि इसमें हर गतिशील स्तंभ शामिल है जो एक तालिका में हो सकता है।

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	डेटासेट जिसमें तालिका है.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।

वापस

एक वादा जिसमें एक ऑब्जेक्ट के रूप में तालिका की स्कीमा शामिल है।

getConnectorTableSchema उदाहरण

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 विधि

निर्दिष्ट कनेक्टर तालिका से एक पंक्ति पुनर्प्राप्त करता है।

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	डेटासेट जिसमें तालिका है.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।
id	string	पुनर्प्राप्त करने के लिए पंक्ति की आईडी.
options	RetrieveConnectorRowOptions	(वैकल्पिक) पंक्ति को पुनः प्राप्त करने के विकल्प।

RetrieveConnectorRowOptions

नाम	प्रकार	विवरण
select	string[]	(सिफारिश की) पुनः प्राप्त करने के लिए स्तंभ नामों की सरणी। यदि छोड़ा गया है, तो कोई $select प्रक्षेपण नहीं भेजा जाता है - कनेक्टर यह निर्धारित करता है कि कौन से कॉलम वापस करने हैं और पंक्ति में प्रत्येक कॉलम को वापस करने की गारंटी नहीं देता है।

वापस

पंक्ति डेटा वाला एक वादा।

retrieveConnectorRow उदाहरण

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 विधि

निर्दिष्ट कनेक्टर तालिका में एक नई पंक्ति बनाता है।

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	डेटासेट जिसमें तालिका है.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।
row	object	बनाने के लिए पंक्ति डेटा.

वापस

कनेक्टर द्वारा लौटाए गए प्रतिक्रिया निकाय वाला एक वादा , यदि कोई हो। कनेक्टर के आधार पर, यह मान बनाई गई पंक्ति, आंशिक पंक्ति या कोई मान नहीं हो सकता है।

createConnectorRow उदाहरण

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 विधि

निर्दिष्ट कनेक्टर तालिका में किसी मौजूदा पंक्ति को अद्यतन करता है.

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	डेटासेट जिसमें तालिका है.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।
id	string	अद्यतन करने के लिए पंक्ति की आईडी.
row	object	अद्यतन करने के लिए पंक्ति डेटा.

वापस

कनेक्टर द्वारा लौटाए गए प्रतिक्रिया निकाय वाला एक वादा , यदि कोई हो। कनेक्टर के आधार पर, यह मान अद्यतन पंक्ति, आंशिक पंक्ति या कोई मान नहीं हो सकता है। पंक्ति के वर्तमान मानों को पढ़ने के लिए, कॉल करें retrieveConnectorRow।

updateConnectorRow उदाहरण

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 विधि

निर्दिष्ट कनेक्टर तालिका से कोई पंक्ति हटाता है.

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
dataset	string	डेटासेट जिसमें तालिका है.
tableName	string	तालिका का आंतरिक नाम, द्वारा लौटाया listConnectorTablesगया गुण name से। प्रदर्शन नाम का उपयोग न करें।
id	string	हटाने के लिए पंक्ति की आईडी.

वापस

ऑपरेशन के परिणाम वाला एक वादा। जब ऑपरेशन सफल होता है, तो यह कोई मान नहीं देता है।

deleteConnectorRow उदाहरण

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 विधि

REST (ऑपरेशन-कुंजीबद्ध) कनेक्टर, जैसे HTTP, Teams भेजें-संदेश या Office 365 Users द्वारा प्रदर्शित नामित कार्रवाई को प्रारंभ करता है. सारणीबद्ध कनेक्टर्स क्वेरी और पंक्ति CRUD विधियों का उपयोग करना चाहिए।

पैरामीटर

इन आवश्यक मापदंडों के लिए मान सेट करें.

नाम	प्रकार	विवरण
connectorLogicalName	string	पृष्ठ से बंधे कनेक्शन संदर्भ का तार्किक नाम.
operationName	string	कनेक्टर की स्वैगर परिभाषा में परिभाषित ऑपरेशन आईडी।
parameters	object	ऑपरेशन के लिए आवश्यक पैरामीटर। एक खाली ऑब्जेक्ट (){} पास करें यदि ऑपरेशन कोई पैरामीटर नहीं लेता है - तो इस पैरामीटर की आवश्यकता तब भी होती है जब भेजने के लिए कुछ भी नहीं होता है।

वापस

इन गुणों के साथ ऑपरेशन परिणाम युक्त एक वादा। यदि कनेक्शन संदर्भ हल नहीं किया जा सकता है, तो कनेक्टर की स्वैगर परिभाषा को पुनर्प्राप्त नहीं किया जा सकता है, ऑपरेशन इसमें नहीं पाया जाता है, कॉल नहीं भेजा जा सकता है, या कनेक्शन अधिकृत नहीं है (HTTP 403) और उपयोगकर्ता कनेक्शन सहमति संकेत को पूरा नहीं करता है।

नाम	प्रकार	विवरण
ok	boolean	true जब अंतर्निहित HTTP स्थिति 400 से कम हो। इस स्थिति में रीडायरेक्ट (3xx) स्थितियाँ शामिल हैं, इसलिए ऑपरेशन द्वारा लौटाए गए डेटा को प्रमाण के रूप में अकेले न मानें ok - यह भी जांचें status या निरीक्षण bodyकरें।
status	number	कनेक्टर द्वारा दिया गया कच्चा HTTP स्थिति कोड।
body	unknown	पार्स किया गया JSON रिस्पॉन्स बॉडी, या कच्ची स्ट्रिंग अगर बॉडी JSON नहीं है।

executeConnectorOperation उदाहरण

निम्न उदाहरण एक ऑपरेशन नाम मानता CopyFile है जो स्वीकार करता है और पैरामीटर destinationUrl करता हैsourceUrl। ऑपरेशन आईडी और इसके मापदंडों को कनेक्टर की अपनी स्वैगर परिभाषा (उदाहरण के लिए, के साथ या listConnectorOperations ) getConnectorSwaggerके खिलाफ सत्यापित करें, क्योंकि उपलब्ध ऑपरेशन और उनके पैरामीटर कनेक्टर द्वारा भिन्न होते हैं।

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);
}