Implementácia vzorovej súčasti webového rozhrania API portálov

Nasleduje príklad implementácie komponentu kódu, ktorý používa portálové webové rozhranie API na vykonávanie akcií vytvorenia, načítania, aktualizácie a vymazania. Komponent vykresľuje štyri tlačidlá, na ktoré je možné kliknúť a vyvolať rôzne akcie webového rozhrania API. Výsledok volania webového rozhrania API sa vloží do prvku HTML div v spodnej časti zložky kódu.

Príklad komponentu využívajúceho webové rozhranie API portálu.

Požiadavky

Kód

Kompletný vzorový komponent si môžete stiahnuť tu.

Štandardne je vo vzorke komponent nakonfigurovaný tak, aby v príkladoch webového rozhrania API vykonával vytváranie, získavanie, nastavovanie polí názvu a výnosov.

Ak chcete zmeniť predvolenú konfiguráciu na ľubovoľnú tabuľku alebo stĺpec, aktualizujte konfiguračné hodnoty uvedené nižšie

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";

Metóda createRecord vykresľuje tri tlačidlá, ktoré vám umožňujú vytvoriť záznam účtu s poľom výnosov nastaveným na rôzne hodnoty (100, 200, 300).

Keď vyberiete jedno z tlačidiel vytvoriť, obsluha udalosti onClick tlačidla skontroluje hodnotu vybraného tlačidla a použije akciu Web API na vytvorenie záznamu účtu s poľom výnosov nastaveným na hodnotu tlačidla. Pole názov záznamu účtu sa nastaví na Kódová zložka webového rozhrania API (ukážka) s náhodným znakom int pridaným na koniec reťazca. Metóda spätného volania z volania webového rozhrania API vloží výsledok volania (úspech alebo zlyhanie) do výsledku vlastného ovládacieho prvku div.

Metóda deleteRecord vykreslí tlačidlo, ktoré vymaže vybraný záznam v rozbaľovacej ponuke. Ovládací prvok rozbaľovacieho zoznamu umožňuje vybrať záznam účtu, ktorý chcete odstrániť. Po výbere záznamu účtu z rozbaľovacej ponuky a po výbere tlačidla Odstrániť záznam sa záznam vymaže. Metóda spätného volania z volania webového rozhrania API vloží výsledok volania (úspech alebo zlyhanie) do výsledku vlastného ovládacieho prvku div.

Metóda vykreslí tlačidlo v komponente kódu. FetchXMLretrieveMultiple Keď sa zavolá metóda tohto tlačidla, vygeneruje sa hodnota onClick a odovzdá sa funkcii FetchXML na výpočet priemernej hodnoty poľa výnosov pre všetky záznamy účtov. retrieveMultiple Metóda spätného volania z volania webového rozhrania API vloží výsledok volania (úspech alebo zlyhanie) do výsledku vlastného ovládacieho prvku div.

Metóda OData retrieveMultiple vykreslí tlačidlo v komponente kódu. Keď sa zavolá metóda onClick tohto tlačidla, vygeneruje sa reťazec OData, ktorý sa odovzdá funkcii retrieveMultiple na načítanie všetkých záznamov o účtoch s poľom názvu, ktoré je podobné kódová zložka Web API (ukážka), čo platí pre všetky záznamy o účtoch vytvorené touto kódovou zložkou.

Pri úspešnom načítaní záznamov má komponent kódu logiku, aby spočítal, koľko záznamov účtov má pole príjmov nastavené na 100, 200 alebo 300, a zobrazí tento počet do kontajnera div stavového kontajnera OData na komponente kódu. Metóda spätného volania z volania webového rozhrania API vloží výsledok volania (úspech alebo zlyhanie) do výsledku vlastného ovládacieho prvku div.

Pozrite si tiež