Query's uitvoeren op Microsoft Graph met behulp van REST

  • 3 minuten

Microsoft Graph is een RESTful-web-API waarmee u toegang hebt tot Microsoft Cloud-serviceresources. Nadat u uw toepassing hebt geregistreerd en verificatietokens hebt ontvangen voor een gebruiker of service, kunt u aanvragen indienen bij de Microsoft Graph API.

De Microsoft Graph API definieert de meeste resources, methoden en opsommingen in de OData-naamruimte, microsoft.graphin de Metagegevens van Microsoft Graph. Er worden enkele API-sets gedefinieerd in hun subnaamruimten, zoals de aanroeprecord-API waarmee resources zoals callRecord in microsoft.graph.callRecordsworden gedefinieerd.

Tenzij expliciet is opgegeven in het bijbehorende onderwerp, gaat u ervan uit dat typen, methoden en opsommingen deel uitmaken van de microsoft.graph naamruimte.

Een REST API-methode aanroepen

Als u wilt lezen van of schrijven naar een resource zoals een gebruiker of een e-mailbericht, maakt u een aanvraag die er als volgt uitziet:

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

De onderdelen van een aanvraag zijn:

  • {HTTP method} - De HTTP-methode die wordt gebruikt voor de aanvraag voor Microsoft Graph.
  • {version} - De versie van de Microsoft Graph API die uw toepassing gebruikt.
  • {resource} - De resource in Microsoft Graph waarnaar u verwijst.
  • {query-parameters} - Optionele OData-queryopties of REST-methodeparameters waarmee het antwoord wordt aangepast.

Nadat u een aanvraag hebt ingediend, wordt er een antwoord geretourneerd dat het volgende omvat:

  • Statuscode: een HTTP-statuscode die aangeeft dat deze is geslaagd of mislukt.
  • Antwoordbericht: de gegevens die u hebt aangevraagd of het resultaat van de bewerking. Het antwoordbericht kan leeg zijn voor sommige bewerkingen.
  • nextLink - Als uw aanvraag talloze gegevens retourneert, moet u deze pagina's doorlopen met behulp van de URL die wordt geretourneerd in @odata.nextLink.

HTTP-methoden

Microsoft Graph gebruikt de HTTP-methode voor uw aanvraag om te bepalen wat uw aanvraag doet. De API ondersteunt de volgende methoden.

Wijze Description
GET Gegevens uit een resource lezen.
POSTEN Maak een nieuwe resource of voer een actie uit.
PATCH Een resource bijwerken met nieuwe waarden.
PUT Vervang een resource door een nieuwe resource.
DELETE Een resource verwijderen.
  • Voor de CRUD-methoden GET en DELETEis er geen aanvraagbody vereist.
  • Voor de POST, PATCHen PUT methoden is een aanvraagbody vereist die is opgegeven in JSON-indeling die aanvullende informatie bevat. Zoals de waarden voor eigenschappen van de resource.

Versie

Microsoft Graph ondersteunt momenteel twee versies: v1.0 en beta.

  • v1.0 bevat algemeen beschikbare API's. Gebruik de versie v1.0 voor alle productie-apps.
  • beta bevat API's die momenteel in preview zijn. Omdat we belangrijke wijzigingen in onze bèta-API's kunnen introduceren, raden we u aan om de bètaversie alleen te gebruiken om apps te testen die in ontwikkeling zijn; gebruik geen bèta-API's in uw productie-apps.

Bron

Een resource kan een entiteit of complex type zijn, meestal gedefinieerd met eigenschappen. Entiteiten verschillen van complexe typen door altijd een id-eigenschap op te geven.

Uw URL bevat de resource waarmee u interactie hebt in de aanvraag, zoals me, gebruiker, groep, station en site. Resources op het hoogste niveau bevatten vaak ook relaties, die u kunt gebruiken voor toegang tot andere resources, zoals me/messages of me/drive. U kunt ook communiceren met resources met behulp van methoden, bijvoorbeeld om een e-mailbericht te verzenden, te gebruiken me/sendMail.

Voor elke resource zijn mogelijk verschillende machtigingen vereist om deze te openen. U hebt vaak een hoger machtigingsniveau nodig om een resource te maken of bij te werken dan om deze te lezen. Zie het naslagonderwerp over methoden voor meer informatie over vereiste machtigingen.

Queryparameters

Queryparameters kunnen OData-systeemqueryopties zijn of andere tekenreeksen die een methode accepteert om het antwoord ervan aan te passen.

U kunt optionele OData-systeemqueryopties gebruiken om meer of minder eigenschappen op te nemen dan het standaardantwoord, het antwoord filteren op items die overeenkomen met een aangepaste query of een andere parameters voor een methode opgeven.

Als u bijvoorbeeld de volgende filter parameter toevoegt, worden de berichten die worden geretourneerd, beperkt tot alleen berichten met de emailAddress eigenschap van jon@contoso.com.

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

Meer informatie

Hieronder vindt u koppelingen naar enkele hulpprogramma's die u kunt gebruiken om aanvragen te bouwen en te testen met behulp van Microsoft Graph-API's.