Tee kysely Microsoft Graphista REST:n avulla

  • 3 minuuttia

Microsoft Graph on RESTful-verkko-ohjelmointirajapinta, jonka avulla voit käyttää Microsoftin pilvipalveluresursseja. Kun olet rekisteröinyt sovelluksesi ja saanut käyttäjän tai palvelun todennustunnukset, voit tehdä pyyntöjä Microsoft Graph -ohjelmointirajapintaan.

Microsoft Graph -ohjelmointirajapinta määrittää useimmat sen resurssit, menetelmät ja luetteloinnit OData-nimitilaan microsoft.graphMicrosoft Graphin metatietojen . Alanimitiloissa on määritetty muutamia ohjelmointirajapintajoukkoja, kuten kutsumaan tietueita -ohjelmointirajapinta- joka määrittää resurssit, kuten callRecordmicrosoft.graph.callRecords.

Ellei vastaavassa aiheessa nimenomaisesti määritetä, oletuksen tyypit, menetelmät ja luetteloinnit ovat osa microsoft.graph nimitilaa.

REST-ohjelmointirajapinnan kutsuminen

Jos haluat lukea resurssista tai kirjoittaa siihen, kuten käyttäjä tai sähköpostiviesti, luo seuraavan esimerkin kaltainen pyyntö:

{HTTP method} https://graph.microsoft.com/{version}/{resource}?{query-parameters}

Pyynnön osia ovat seuraavat:

  • {HTTP method} – Microsoft Graphille pyynnössä käytetty HTTP-menetelmä.
  • {version} – Sovelluksen käyttämä Microsoft Graph -ohjelmointirajapinnan versio.
  • {resource} – Se Microsoft Graph -resurssi, johon viittaat.
  • {query-parameters} – Valinnaiset OData-kyselyasetukset tai REST-menetelmän parametrit, jotka mukauttavat vastausta.

Kun olet tehnyt pyynnön, palautetaan vastaus, joka sisältää:

  • Tilakoodi: HTTP-tilakoodi, joka ilmaisee onnistumisen tai epäonnistumisen.
  • Vastausviesti – Pyytämäsi tiedot tai toiminnon tulos. Vastausviesti voi olla tyhjä joillekin toiminnoille.
  • nextLink – Jos pyyntösi palauttaa useita tietoja, sinun on sivutettava se käyttämällä @odata.nextLinkpalautettua URL-osoitetta.

HTTP-menetelmät

Microsoft Graph käyttää pyynnössäsi HTTP-menetelmää pyyntösi tekemisen määrittämiseen. -ohjelmointirajapinta tukee seuraavia menetelmiä.

Menetelmä Kuvaus
SAADA Lue tietoja resurssista.
POSTI Luo uusi resurssi tai suorita toiminto.
LAASTARI Päivitä resurssi uusilla arvoilla.
ASETTAA Korvaa resurssi uudella.
POISTAA Poista resurssi.
  • CRUD-menetelmissä GET ja DELETEpyynnön runkoa ei tarvita.
  • -POST-, PATCH- ja PUT -menetelmät edellyttävät lisätietoa sisältävää JSON-muodossa määritettyä pyynnön runkoa. Esimerkiksi resurssin ominaisuuksien arvot.

Versio

Microsoft Graph tukee tällä hetkellä kahta versiota: v1.0 ja beta.

  • v1.0 sisältää yleisesti saatavilla olevat ohjelmointirajapinnat. Käytä v1.0-versiota kaikille tuotantosovelluksille.
  • beta sisältää ohjelmointirajapintoja, jotka ovat tällä hetkellä esikatselussa. Koska saatamme aiheuttaa rikkovia muutoksia beeta-ohjelmointirajapintoihimme, suosittelemme, että käytät beetaversiota vain kehitteillä olevien sovellusten testaamiseen. älä käytä beeta-ohjelmointirajapintoja tuotantosovelluksissasi.

Resurssi

Resurssi voi olla entiteetti tai monimutkainen tyyppi, joka on yleisesti määritetty ominaisuuksilla. Entiteetit eroavat monimutkaisista tyypeistä sisällyttämällä aina tunnuksen ominaisuuden.

URL-osoitteesi sisältää resurssin, jota käsittelet pyynnössä, kuten me, käyttäjän, ryhmän, drive, ja site. Usein ylimmän tason resurssit sisältävät myös suhteita, joiden avulla voit käyttää muita resursseja, kuten me/messages tai me/drive. Voit myös käsitellä resursseja käyttämällä menetelmiä; Jos haluat esimerkiksi lähettää sähköpostiviestin, käytä me/sendMail.

Jokaisen resurssin käyttö voi edellyttää eri käyttöoikeuksia. Resurssin luomiseen tai päivittämiseen tarvitaan usein korkeampi käyttöoikeustaso kuin sen lukeminen. Lisätietoja vaadituista käyttöoikeuksista on -menetelmän ohjeaiheessa.

Kyselyparametrit

Kyselyparametrit voivat olla OData-järjestelmän kyselyasetuksia tai muita merkkijonoja, jotka menetelmä hyväksyy vastauksen mukauttamiseksi.

Valinnaisten OData-järjestelmän kyselyasetusten avulla voit sisällyttää enemmän tai vähemmän ominaisuuksia kuin oletusvastauksen. Voit suodattaa mukautettua kyselyä vastaavien kohteiden vastauksen tai antaa menetelmälle toisen parametrin.

Esimerkiksi seuraavan filter parametrin lisääminen rajoittaa palautettuja viestejä, joissa on emailAddressjon@contoso.com-ominaisuus.

GET https://graph.microsoft.com/v1.0/me/messages?filter=emailAddress eq 'jon@contoso.com'

Muut resurssit

Seuraavassa on linkkejä joihinkin työkaluihin, joiden avulla voit luoda ja testata pyyntöjä Microsoft Graph -ohjelmointirajapintojen avulla.