Mukautetun ohjelmointirajapinnan luominen Power Appsissa

Tässä artikkelissa kerrotaan, miten voit luoda mukautetun ohjelmointirajapinnan Power Apps Microsoft Dataverse ratkaisun avulla. Näiden ohjeiden avulla voit määrittää pyyntö- ja vastausominaisuudet, testata mukautettua ohjelmointirajapintaa ja liittää sen laajennuksen tyypin. Jos et ole aiemmin tutustunut ratkaisuihin, lue ensin Luo ratkaisu.

Ratkaisusi on liityttävä julkaisijaan. Julkaisijalla on tietty mukautusetuliite, joka liittyy siihen. Mukautusetuliitteen on oltava käytössä, kun luot mukautetun ohjelmointirajapinnan. Tämän etuliitteen on oltava sama etuliite, jota ratkaisusi julkaisija käyttää. Seuraavissa ohjeissa käytetään arvoa sample mukautuksen etuliitteenä, koska se on julkaisijalle määritetty arvo.

Mukautetun ohjelmointirajapintatietueen luominen

1. Valitse ratkaisussasi avattavasta luettelosta Uusi>lisää>muita>mukautettu ohjelmointirajapinta .

2. Määritä mukautetun ohjelmointirajapinnan ominaisuudet muokkaamalla kenttiä. Määritä arvot seuraaville kentille. Lisätietoja on artikkelissa Mukautetun ohjelmointirajapinnan taulukon sarakkeet.

   Laajennuksen tyypille ei voi määrittää arvoja ennen laajennuksen luomista. Voit muuttaa tätä arvoa myöhemmin.

3. Valitse Tallenna. Lomakkeesi pitäisi näyttää samalta kuin seuraavassa kuvassa:

Pyyntöparametrien luominen

Mukautettu ohjelmointirajapinta ei edellytä parametreja. Luo niin monta parametria kuin tarvitset välittääksesi logiikkasi edellyttämät tiedot.

1. Valitse ratkaisussasi avattavasta valikosta Uusi>lisää>muita>mukautettuja ohjelmointirajapinnan pyyntöparametreja .

2. Muokkaa kenttiä mukautetun ohjelmointirajapintapyyntöparametrin ominaisuuksien määrittämiseksi. Lisätietoja on kohdassa CustomAPIRequestParameter-taulukon sarakkeet.

3. Valitse Tallenna. Lomakkeesi pitäisi näyttää samalta kuin seuraavassa kuvassa:

   

Vastausominaisuuksien luominen

Toimintoa edustava mukautettu ohjelmointirajapinta ei edellytä vastauksen ominaisuuksia. Funktiolla on oltava vähintään yksi. Jos toiminto onnistuu, se palauttaa onnistumisvastauksen. Jos se epäonnistuu, se palauttaa virheen. Määritä vastausominaisuudet kaikille tiedoille, jotka ohjelmointirajapintasi palauttaa.

Jos määrität vain yhden Entiteetti - tai EntityCollection-vastausominaisuuden , vastaus on tämäntyyppinen. Jos määrität useita ominaisuuksia tai yhden tai useamman yksinkertaisen tyypin ominaisuuden, ohjelmointirajapinta palauttaa monimutkaisen tyypin, jossa jokainen vastauksen ominaisuus on kyseisen monimutkaisen tyypin ominaisuus.

Jos esimerkiksi mukautetun ohjelmointirajapinnan yksilöivä nimi on sample_CustomAPIExample, se palauttaa monimutkaisen tyypin nimeltä sample_CustomAPIExampleResponse , joka sisältää ominaisuudet kullekin määrittämällesi vastausominaisuudelle.

1. Valitse ratkaisussasi avattavasta valikosta Uusi>lisää>muita>mukautettuja ohjelmointirajapinnan vastausominaisuudet .

2. Muokkaa kenttiä ja määritä mukautetun ohjelmointirajapinnan vastausominaisuuden ominaisuudet. Lisätietoja on kohdassa CustomAPI-vastauksen ominaisuustaulukon sarakkeet.

3. Valitse Tallenna. Lomakkeesi pitäisi näyttää samalta kuin seuraavassa kuvassa:

   

Tarkastele palveluasiakirjan tulosta

Jos et määritä mukautetun IsPrivate ohjelmointirajapinnan ominaisuutta, voit noutaa palvelumääritelmän CSDL-$metadata tiedostosta käyttämällä pyyntöä GET myös selaimestasi. Jos ympäristösi URL-osoite on https://yourorg.crm.dynamics.com, voit hakea $metadata kirjoittamalla tämän URL-osoitteen selaimen osoitekenttään: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Hae tuloksesta mukautetun ohjelmointirajapinnan nimi. Esimerkiksi edellisiä vaiheita käyttämällä määritetty ohjelmointirajapinta näyttää tältä:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

Oman ohjelmointirajapinnan testaaminen

Kun olet luonut mukautetun ohjelmointirajapinnan, voit kokeilla sitä. Vaikka et määrittäisit päätoimintoa määrittämällä laajennustyyppiä, voit testata sen nyt ja varmistaa, että voit kutsua sen oikein. Mitkä tahansa vastausominaisuudet palauttavat oletusarvonsa, kuten tyhjäarvon. Lisätietoja on artikkelissa Mukautettujen ohjelmointirajapintojen käynnistäminen.

Mukautetun ohjelmointirajapinnan laajennuksen tyypin päivittäminen

Lisätietoja laajennuksen kirjoittamisesta mukautetulle ohjelmointirajapinnalle on artikkelissa Laajennuksen kirjoittaminen mukautettua ohjelmointirajapintaa varten.

Kun olet rekisteröinyt kokoonpanon, sinun on määritettävä laajennuksen tyypin arvo luomallesi mukautetulle ohjelmointirajapinnalle. Tämä arvo on hakuominaisuus, joten sinun tarvitsee vain etsiä laajennustyyppi, joka edustaa kokoonpanon rekisteröinnin yhteydessä luotua tyyppiä.

Kun olet määrittänyt laajennuksen tyypin, voit testata mukautettua ohjelmointirajapintaa ja varmistaa, että oikeat tulokset palautetaan.

Muita mukautettujen ohjelmointirajapintojen luontitapoja

Laajennuksen rekisteröintityökalu tarjoaa mukautetun ohjelmointirajapinnan suunnittelutyökalun. Lisätietoja on artikkelissa Mukautetun ohjelmointirajapinnan luominen laajennuksen rekisteröintityökalun avulla.

Sinun täytyy ehkä luoda asiakassovellus, joka sallii mukautettujen ohjelmointirajapintojen luomisen suunnittelutyökalun ulkopuolella. Koska mukautettujen ohjelmointirajapintojen tiedot on tallennettu taulukoihin, voit luoda ne koodia käyttämällä. Lisätietoja on artikkelissa Mukautetun ohjelmointirajapinnan luominen koodilla.

ALM-prosessiasi voi parantaa luomalla mukautettuja ohjelmointirajapintoja muokkaamalla ratkaisutiedostoja. Lisätietoja on artikkelissa Mukautetun ohjelmointirajapinnan luominen ratkaisutiedostojen avulla.

Katso myös

Mukautettujen ohjelmointirajapintojen luominen ja käyttäminen
Mukautetun ohjelmointirajapinnan luominen laajennuksen rekisteröintityökalun avulla
Mukautetun ohjelmointirajapinnan luominen koodin avulla
Luo mukautettu ohjelmointirajapinta ratkaisutiedostojen avulla
Omien viestien luominen