Fråga Microsoft Graph med hjälp av REST

  • 3 minuter

Microsoft Graph är ett RESTful-webb-API som gör att du kan komma åt Microsoft Cloud-tjänstresurser. När du har registrerat din app och hämtat autentiseringstoken för en användare eller tjänst kan du göra begäranden till Microsoft Graph-API:et.

Microsoft Graph-API:et definierar de flesta av dess resurser, metoder och uppräkningar i OData-namnområdet i microsoft.graphMicrosoft Graph-metadata. Några API-uppsättningar definieras i deras undernamn, till exempel API:et

Om inte uttryckligen anges i motsvarande ämne, förutsätter du att typer, metoder och uppräkningar är en del av microsoft.graph namnområdet.

Anropa en REST API-metod

Om du vill läsa från eller skriva till en resurs, till exempel en användare eller ett e-postmeddelande, skapar du en begäran som ser ut som följande exempel:

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

Komponenterna i en begäran är:

  • {HTTP method} – HTTP-metoden som används för begäran till Microsoft Graph.
  • {version} – Den version av Microsoft Graph API som ditt program använder.
  • {resource} – Resursen i Microsoft Graph som du refererar till.
  • {query-parameters} – Valfria OData-frågealternativ eller REST-metodparametrar som anpassar svaret.

När du har skapat en begäran returneras ett svar som innehåller:

  • Statuskod – en HTTP-statuskod som anger lyckad eller misslyckad.
  • Svarsmeddelande – De data som du begärde eller resultatet av åtgärden. Svarsmeddelandet kan vara tomt för vissa åtgärder.
  • nextLink – Om din begäran returnerar många data måste du bläddra igenom den med hjälp av url:en som returneras i @odata.nextLink.

HTTP-metoder

Microsoft Graph använder HTTP-metoden på din begäran för att avgöra vad din begäran gör. API:et stöder följande metoder.

Metod beskrivning
FÅ Läsa data från en resurs.
Posten Skapa en ny resurs eller utför en åtgärd.
Patch Uppdatera en resurs med nya värden.
LÄGG Ersätt en resurs med en ny.
TA BORT Ta bort en resurs.
  • För CRUD-metoderna GET och DELETEkrävs ingen begärandetext.
  • Metoderna POST, PATCHoch PUT kräver en begärandetext som anges i JSON-format som innehåller ytterligare information. Till exempel värden för resursens egenskaper.

Utgåva

Microsoft Graph stöder för närvarande två versioner: v1.0 och beta.

  • v1.0 innehåller allmänt tillgängliga API:er. Använd v1.0-versionen för alla produktionsappar.
  • beta innehåller API:er som för närvarande är i förhandsversion. Eftersom vi kan introducera icke-bakåtkompatibla ändringar i våra beta-API:er rekommenderar vi att du endast använder betaversionen för att testa appar som är under utveckling. använd inte beta-API:er i dina produktionsappar.

Resurs

En resurs kan vara en entitet eller komplex typ, som ofta definieras med egenskaper. Entiteter skiljer sig från komplexa typer genom att alltid inkludera en ID-egenskap .

Url:en innehåller den resurs som du interagerar med i begäran, till exempel me, användare, grupp, enhet och webbplats. Resurser på den översta nivån innehåller ofta även relationer som du kan använda för att komma åt andra resurser, till exempel me/messages eller me/drive. Du kan också interagera med resurser med hjälp av metoder. Om du till exempel vill skicka ett e-postmeddelande använder du me/sendMail.

Varje resurs kan kräva olika behörigheter för att komma åt den. Du behöver ofta en högre behörighetsnivå för att skapa eller uppdatera en resurs än för att läsa den. Mer information om nödvändiga behörigheter finns i metodreferensavsnittet.

Frågeparametrar

Frågeparametrar kan vara OData-systemfrågealternativ eller andra strängar som en metod accepterar för att anpassa svaret.

Du kan använda valfria OData-systemfrågealternativ för att inkludera fler eller färre egenskaper än standardsvaret. Du kan filtrera svaret för objekt som matchar en anpassad fråga eller ange andra parametrar för en metod.

Om du till exempel lägger till följande filter parameter begränsas de meddelanden som returneras med emailAddress egenskapen jon@contoso.com.

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

Andra resurser

Här följer länkar till vissa verktyg som du kan använda för att skapa och testa begäranden med hjälp av Microsoft Graph-API:er.