Forespørg Microsoft Graph ved hjælp af REST

  • 3 minutter

Microsoft Graph er en RESTful-web-API, der giver dig adgang til Microsoft Cloud Service-ressourcer. Når du har registreret din app og fået godkendelsestokens for en bruger eller tjeneste, kan du foretage anmodninger til Microsoft Graph-API'en.

Microsoft Graph API definerer de fleste af dens ressourcer, metoder og optællinger i OData-navneområdet microsoft.graphi Microsoft Graph-metadata. Der er defineret nogle få API-sæt i deres undernavneområder, f.eks. API-for kaldposter, der definerer ressourcer som callRecord- i microsoft.graph.callRecords.

Medmindre det udtrykkeligt er angivet i det tilsvarende emne, skal du antage, at typer, metoder og optællinger er en del af det microsoft.graph navneområde.

Kald en REST API-metode

Hvis du vil læse fra eller skrive til en ressource, f.eks. en bruger eller en mail, skal du oprette en anmodning, der ligner følgende eksempel:

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

Komponenterne i en anmodning omfatter:

  • {HTTP method} – Den HTTP-metode, der bruges på anmodningen til Microsoft Graph.
  • {version} – Den version af Microsoft Graph API, dit program bruger.
  • {resource} – Den ressource i Microsoft Graph, du refererer til.
  • {query-parameters} – Valgfri OData-forespørgselsindstillinger eller parametre for REST-metoden, der tilpasser svaret.

Når du har sendt en anmodning, returneres der et svar, der omfatter:

  • Statuskode – En HTTP-statuskode, der angiver, om det lykkedes eller mislykkedes.
  • Svarmeddelelse – De data, du har anmodet om, eller resultatet af handlingen. Svarmeddelelsen kan være tom for nogle handlinger.
  • nextLink – Hvis din anmodning returnerer mange data, skal du bladre gennem den ved hjælp af den URL-adresse, der returneres i @odata.nextLink.

HTTP-metoder

Microsoft Graph bruger HTTP-metoden på din anmodning til at bestemme, hvad din anmodning gør. API'en understøtter følgende metoder.

Metode Beskrivelse
FÅ Læs data fra en ressource.
POST Opret en ny ressource, eller udfør en handling.
PATCH Opdater en ressource med nye værdier.
SÆTTE Erstat en ressource med en ny.
SLETTE Fjern en ressource.
  • For CRUD-metoderne GET og DELETEkræves der ingen anmodningsbrødtekst.
  • Metoderne POST, PATCHog PUT kræver en anmodningsbrødtekst, der er angivet i JSON-format, og som indeholder flere oplysninger. F.eks. værdierne for egenskaberne for ressourcen.

Version

Microsoft Graph understøtter i øjeblikket to versioner: v1.0 og beta.

  • v1.0 indeholder offentligt tilgængelige API'er. Brug v1.0-versionen til alle produktionsapps.
  • beta indeholder API'er, der i øjeblikket er en prøveversion. Da vi kan introducere banebrydende ændringer af vores beta-API'er, anbefaler vi, at du kun bruger betaversionen til at teste apps, der er under udvikling. brug ikke beta-API'er i dine produktionsapps.

Ressource

En ressource kan være en enhed eller kompleks type, der ofte defineres med egenskaber. Objekter adskiller sig fra komplekse typer ved altid at inkludere et id egenskab.

URL-adressen indeholder den ressource, du interagerer med i anmodningen, f.eks. me, bruger, gruppe, drevog websted. Ressourcer på øverste niveau omfatter ofte også relationer, som du kan bruge til at få adgang til andre ressourcer, f.eks. me/messages eller me/drive. Du kan også interagere med ressourcer ved hjælp af metoder; Hvis du f.eks. vil sende en mail, skal du bruge me/sendMail.

Hver ressource kan kræve forskellige tilladelser for at få adgang til den. Du har ofte brug for et højere tilladelsesniveau for at oprette eller opdatere en ressource end for at læse den. Du kan finde flere oplysninger om påkrævede tilladelser i emnet metodereference.

Forespørgselsparametre

Forespørgselsparametre kan være OData-systemforespørgselsindstillinger eller andre strenge, som en metode accepterer for at tilpasse svaret.

Du kan bruge valgfri OData-systemforespørgselsindstillinger til at inkludere flere eller færre egenskaber end standardsvaret. Du kan filtrere svaret for elementer, der svarer til en brugerdefineret forespørgsel, eller angive andre parametre for en metode.

Hvis du f.eks. tilføjer følgende filter parameter, begrænses de meddelelser, der returneres med egenskaben emailAddress for jon@contoso.com.

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

Andre ressourcer

Følgende er links til nogle værktøjer, du kan bruge til at bygge og teste anmodninger ved hjælp af Microsoft Graph API'er.