Implementace ukázkové komponenty webového rozhraní API portálu
Následuje příklad implementace komponenty kódu, která používá portálové webové rozhraní API k provádění akcí vytváření, načítání, aktualizace a odstraňování. Komponenta vykresluje čtyři tlačítka, na která lze kliknout a vyvolat různé akce webového rozhraní API. Výsledek volání webového rozhraní API je vložen do prvku HTML div ve spodní části komponenty kódu.
Předpoklady
- Verze vašeho portálu musí být 9.3.10.x nebo vyšší.
- Váš startovací balíček portálu musí být 9.2.2103.x nebo vyšší.
- Chcete-li povolit webové rozhraní API ve vašem portálu, musíte povolit nastavení webu. Nastavení webu pro webové rozhraní API
- Konfigurujte zabezpečení tabulky pomocí jejích oprávnění. Oprávnění k tabulce
Kód
Kompletní ukázkovou komponentu si můžete stáhnout zde.
Ve výchozím nastavení je v ukázce komponenta konfigurována tak, aby v příkladech webového rozhraní API prováděla vytváření, načítání a nastavení polí názvu a výnosů.
Chcete-li změnit výchozí konfiguraci na jakoukoli tabulku nebo sloupec, aktualizujte níže uvedené konfigurační hodnoty podle toho, jak jsou znázorněny
private static \_entityName = "account";
private static \_requiredAttributeName = "name";
private static \_requiredAttributeValue = "Web API Custom Control (Sample)";
private static \_currencyAttributeName = "revenue";
private static \_currencyAttributeNameFriendlyName = "annual revenue";
Metoda createRecord vykresluje tři tlačítka, což umožňuje vytvořit záznam účtu s polem výnosů nastaveným na různé hodnoty (100, 200, 300).
Když vyberete jedno z tlačítek pro vytvoření, obslužná rutina události onClick tlačítka zkontroluje hodnotu vybraného tlačítka a použije akci webového rozhraní API k vytvoření záznamu účtu s polem výnosů nastaveným na hodnotu tlačítka. Pole názvu záznamu účtu bude nastaveno na Komponenta kódu webového rozhraní API (ukázka) s náhodným celým číslem int připojeným na konec řetězce. Metoda zpětného volání z volání webového rozhraní API vloží výsledek volání (úspěch nebo selhání) do výsledku vlastního ovládacího prvku div.
Metoda deleteRecord vykreslí tlačítko, které smaže vybraný záznam v rozevíracím seznamu. Ovládací prvek Dropdown vám umožňuje vybrat záznam účtu, který chcete odstranit. Po výběru záznamu účtu v rozevíracím seznamu a tlačítka Odstranit záznam se záznam odstraní. Metoda zpětného volání z volání webového rozhraní API vloží výsledek volání (úspěch nebo selhání) do výsledku vlastního ovládacího prvku div.
Metoda FetchXMLretrieveMultiple vykreslí tlačítko v komponentě kódu. Když se zavolá metoda tohoto tlačítka onClick, vygeneruje se FetchXML a předá se do funkce retrieveMultiple, aby byla vypočítána průměrná hodnota pole výnosů pro všechny účetní záznamy. Metoda zpětného volání z volání webového rozhraní API vloží výsledek volání (úspěch nebo selhání) do výsledku vlastního ovládacího prvku div.
Metoda OData retrieveMultiple vykreslí tlačítko v komponentě kódu. Když je zavolána metoda onClick tohoto tlačítka, je vygenerován řetězec OData a předán do funkce retrieveMultiple za účelem načtení všech záznamů účtu s polem názvu, které se podobá řetězci komponenta kódu webového API (ukázka), což platí pro všechny záznamy účtů vytvořené touto komponentou kódu.
Při úspěšném načtení záznamů má komponenta kódu logiku ke spočítání, kolik záznamů účtu má pole výnosů nastaveno na 100, 200 nebo 300, a zobrazí tento počet v prvku DIV kontejneru stavu OData v komponentě kódu. Metoda zpětného volání z volání webového rozhraní API vloží výsledek volání (úspěch nebo selhání) do výsledku vlastního ovládacího prvku div.