Esimerkkiportaalin verkko-ohjelmointirajapinnan komponentin toteuttaminen
Seuraavassa on esimerkki sellaisen koodikomponentin toteuttamisesta, joka käyttää portaalin Web API -liittymää toimintojen luomiseen, noutamiseen, päivittämiseen ja poistamiseen. Komponentti muodostaa neljä painiketta, joita voidaan napsauttaa, kun haluat käynnistää erilaisia Web API -toimintoja. Web API -kutsun tulos syötetään koodikomponentin alareunassa olevaan HTML-div-elementtiin.
edellytykset
- Portaaliversion on oltava vähintään 9.3.10.x.
- Aloitusportaalin paketin version on oltava 9.2.2103.x tai uudempi.
- Sivustoasetus on otettava käyttöön, jotta portaalien Web API voidaan ottaa käyttöön portaalissa. Verkko-ohjelmointirajan sivuston asetukset
- Määritä taulukon suojaus taulukon oikeuksilla. Taulukon oikeudet
Koodi
Voit ladata koko mallikomponentin täältä.
Oletusarvon mukaan komponentti on määritetty suorittamaan Web API -esimerkkien luonti-, nouto- ja tuottokentät.
Jos haluat muuttaa oletuskokoonpanon mihin tahansa taulukkoon tai sarakkeeseen, päivitä alla olevat määritysarvot esitetyllä tavalla
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";
createRecord-menetelmä muodostaa kolme painiketta, joiden avulla voit luoda asiakastietueen, jonka tuottokentän arvoksi on määritetty eri arvot (100, 200, 300).
Kun valitset jonkin luontipainikkeista, painikkeen onClick-tapahtumakäsittelijä tarkistaa valitun painikkeen arvon ja luo Web API -toiminnon avulla asiakastietueen, jonka tuottokentän arvoksi on määritetty painikkeen arvo. Tilitietueen nimikentäksi määritetään Web API -koodikomponentti (esimerkki), jonka loppuun on liitetty satunnainen int-merkkijono. Web API -kutsun takaisinsoittotapa lisää kutsun tuloksen (onnistuminen tai epäonnistuminen) mukautetun ohjausobjektin tulokseen div.
deleteRecord-menetelmä muodostaa painikkeen, joka poistaa valitun tietueen avattavasta valikosta. Avattavan vaihtoehdon avulla voit valita poistettavan tilitietueen. Kun avattavasta valikosta on valittu asiakastietue ja Poista tietue -painike on valittuna, tietue poistetaan. Web API -kutsun takaisinsoittotapa lisää kutsun tuloksen (onnistuminen tai epäonnistuminen) mukautetun ohjausobjektin tulokseen div.
Menetelmä FetchXMLretrieveMultiple hahmontaa painikkeen koodikomponentissa. Kun tämän painikkeen onClick menetelmää kutsutaan,luodaan FetchXML ja välitetään funktiolle retrieveMultiple kaikkien tilitietueiden tuottokentän keskiarvon laskemiseksi. Web API -kutsun takaisinsoittotapa lisää kutsun tuloksen (onnistuminen tai epäonnistuminen) mukautetun ohjausobjektin tulokseen div.
OData-retrieveMultiple-menetelmä muodostaa koodin osan painikkeen. Kun tämän painikkeen onClick-menetelmää kutsutaan, OData-merkkijono luodaan ja välitetään retrieveMultiple-funktiolle, jotta kaikki tilitietueet, joiden nimikenttä on kuin koodikomponentti Web API (esimerkki), joka koskee kaikkia tämän koodikomponentin luomia tilitietueita.
Kun tietueiden noutaminen onnistuu, koodikomponentin logiikka määrittää, kuinka monen tilitietueen tuottokentän arvo on 100, 200 tai 300, ja näyttää tämän määrän OData-tilasäilön div-koodikomponentissa. Web API -kutsun takaisinsoittotapa lisää kutsun tuloksen (onnistuminen tai epäonnistuminen) mukautetun ohjausobjektin tulokseen div.