Pasirinktinės API kūrimas "Power Apps"

Šiame straipsnyje aiškinama, kaip sukurti pasirinktinę API Power Apps Microsoft Dataverse naudojant sprendimą. Atlikite šiuos veiksmus, kad apibrėžtumėte užklausos ir atsakymo ypatybes, išbandytumėte pasirinktinę API ir susietumėte jo priedo tipą. Jei nesate susipažinę su sprendimais, pirmiausia perskaitykite Sprendimo kūrimas.

Jūsų sprendimas turi būti susietas su leidėju. Leidėjas turi su juo susietą konkretų tinkinimo priešdėlį. Kurdami pasirinktinę API turite naudoti tinkinimo prefiksą, o šis prefiksas turi būti toks pat priešdėlis, kurį naudoja jūsų sprendimo leidėjas. Toliau pateiktose instrukcijose reikšmė sample naudojama kaip tinkinimo priešdėlis, nes ji nustatyta leidėjui.

Svarbu

• Dabar yra geresnė pasirinktinės API kūrimo patirtis. Galite naudoti dizaino įrankį papildinio registracijos įrankyje. Daugiau informacijos žr. Pasirinktinės API kūrimas naudojant priedo registracijos įrankį.
• Negalite keisti daugelio laukų, susijusių su pasirinktinės API kūrimu, kai juos sukuriate. Atidžiai planuokite pasirinktinės API dizainą prieš pradėdami. Jei vėliau nuspręsite, kad jums reikia pakeisti šiuos laukus, gali tekti panaikinti esamą įrašą ir iš naujo sukurti pasirinktinę API. Daugiau informacijos žr. CustomAPI lentelės.

Tinkinto API įrašo kūrimas

1. Sprendime išplečiamajame meniu pasirinkite Nauja>daugiau>Kita>tinkinta API .

2. Redaguokite laukus, kad nustatytumėte pasirinktinės API ypatybes. Nustatykite šių laukų reikšmes. Daugiau informacijos žr. Pasirinktiniai API lentelės stulpeliai.

   Prieš kurdami priedą negalite nustatyti priedo tipo reikšmių. Šią reikšmę galite pakeisti vėliau.

3. Pasirinkite Įrašyti. Jūsų forma turėtų atrodyti panašiai kaip šis vaizdas:

Kurti užklausos parametrus

Tinkintai API nereikia parametrų. Sukurkite tiek parametrų, kiek reikia jūsų logikai reikalingiems duomenims perduoti.

1. Sprendime išskleidžiamajame meniu pasirinkite Naujas>kitas>>tinkintas API užklausos parametras.

2. Redaguokite laukus, kad nustatytumėte pasirinktinio API užklausos parametro ypatybes. Daugiau informacijos žr. CustomAPIRequestParameter lentelės stulpeliai.

3. Pasirinkite Įrašyti. Jūsų forma turėtų atrodyti panašiai kaip šis vaizdas:

   

Kurti atsakymo ypatybes

Pasirinktinei API, kuri nurodo veiksmą, atsakymo ypatybių nereikia. Funkcija turi turėti bent vieną. Jei operacija pavyksta, ji pateikia sėkmingą atsakymą. Jei nepavyksta, pateikiama klaida. Apibrėžkite bet kokių duomenų, kuriuos pateikia jūsų API, atsakymo ypatybes.

Jei nustatote tik vieną subjekto arba EntityCollection atsakymo ypatybę, atsakymas yra to tipo. Jei apibrėžiate kelias ypatybes arba vieną ar daugiau paprastojo tipo ypatybių, API pateikia sudėtingą tipą, kuriame kiekviena atsakymo ypatybė yra to sudėtinio tipo ypatybė.

Pavyzdžiui, jei jūsų pasirinktinis API unikalus pavadinimas yra sample_CustomAPIExample, ji pateikia sudėtinį tipą, pavadintą sample_CustomAPIExampleResponse kiekvienos jūsų apibrėžtos atsakymo ypatybės.

1. Sprendime išplečiamajame meniu pasirinkite Nauja>kita>>tinkinta API atsakymo ypatybė.

2. Redaguokite laukus, kad nustatytumėte pasirinktinės API atsakymo ypatybės ypatybes. Daugiau informacijos žr. CustomAPIResponseProperty lentelės stulpeliai.

3. Pasirinkite Įrašyti. Jūsų forma turėtų atrodyti panašiai kaip šis vaizdas:

   

Atkreipkite dėmesį į rezultatą techninės priežiūros dokumente

Jei nenustatysite IsPrivate savo pasirinktinės API ypatybės, galėsite gauti tarnybos aprašą iš CSDL $metadata dokumento naudodami užklausą GET net iš naršyklės. Jei jūsų aplinkos URL yra https://yourorg.crm.dynamics.com, galite įvesti šį URL naršyklės adreso lauke, kad gautumėte $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Ieškokite rezultato, kad rastumėte pasirinktinės API pavadinimą. Pvz., API, apibrėžta naudojant ankstesnius veiksmus, atrodo taip:

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

Išbandykite pasirinktinę API

Sukūrę pasirinktinę API, galite ją išbandyti. Net jei nenustatysite priedo tipo pagrindinei operacijai apibrėžti, galite patikrinti jį dabar, kad patikrintumėte, ar galite tinkamai paskambinti. Bet kokios atsakymo ypatybės grąžina numatytąją reikšmę, pvz., nulinę. Daugiau informacijos žr. Pasirinktinių API iškvietimas.

Pasirinktinio API priedo tipo naujinimas

Informacijos apie tai, kaip parašyti pasirinktinės API priedą, ieškokite Pasirinktinės API priedo rašymas.

Užregistravę agregatą, turite nustatyti sukurtos pasirinktinės API įskiepio tipo reikšmę. Ši reikšmė yra peržvalgos ypatybė, todėl jums tereikia rasti priedo tipą, kuris nurodo tipą, sukurtą užregistravus rinkinį.

Nustatę priedo tipą, galite patikrinti pasirinktinę API, kad patikrintumėte, ar pateikti tinkami rezultatai.

Kiti pasirinktinių API kūrimo būdai

Įskiepio registracijos įrankis suteikia pasirinktinį API dizainerį. Daugiau informacijos žr. Pasirinktinės API kūrimas naudojant priedo registracijos įrankį.

Gali kilti reikalavimų sukurti kliento programą, leidžiančią kurti pasirinktines API už dizaino įrankio ribų. Pasirinktinių API duomenys saugomi lentelėse, todėl galite juos sukurti naudodami kodą. Daugiau informacijos žr. Pasirinktinės API su kodu kūrimas.

Jūsų ALM procesas gali būti naudingesnis kuriant pasirinktines API redaguojant sprendimo failus. Daugiau informacijos žr. Pasirinktinės API su sprendimų failais kūrimas.

Taip pat žr.

Pasirinktinių API kūrimas ir naudojimas
Sukurkite pasirinktinę API naudodami įskiepio registracijos įrankį
Sukurkite pasirinktinę API su kodu
Pasirinktinės API su sprendimo failais kūrimas
Sukurkite savo pranešimus