Dotazování Microsoft Graphu pomocí REST

3 min

Microsoft Graph je webové rozhraní RESTful API, které umožňuje přístup k prostředkům cloudové služby Microsoftu. Po registraci aplikace a získání ověřovacích tokenů pro uživatele nebo službu můžete vyhovět rozhraní Microsoft Graph API.

Rozhraní Microsoft Graph API definuje většinu svých prostředků, metod a výčtů v oboru názvů microsoft.graphOData v metadatech Microsoft Graphu. Několik sad rozhraní API je definováno v jejich podnázvových prostorech, například rozhraní API záznamů volání, které definuje prostředky, jako je callRecord in microsoft.graph.callRecords.

Pokud nejsou explicitně uvedeny v odpovídajícím tématu, předpokládají typy, metody a výčty jsou součástí microsoft.graph oboru názvů.

Volání metody ROZHRANÍ REST API

Pokud chcete číst z nebo zapisovat do prostředku, jako je uživatel nebo e-mailová zpráva, vytvořte požadavek, který vypadá jako v následující ukázce:

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

Mezi komponenty požadavku patří:

{HTTP method} – Metoda HTTP použitá v požadavku na Microsoft Graph.
{version} – Verze rozhraní Microsoft Graph API, které vaše aplikace používá.
{resource} – Prostředek v Microsoft Graphu, na který odkazujete.
{query-parameters} – Volitelné možnosti dotazu OData nebo parametry metody REST, které přizpůsobí odpověď.

Po provedení požadavku se vrátí odpověď, která zahrnuje:

Stavový kód – stavový kód HTTP, který označuje úspěch nebo selhání.
Zpráva odpovědi – data, která jste požadovali, nebo výsledek operace. Zpráva odpovědi může být pro některé operace prázdná.
nextLink - Pokud vaše žádost vrátí řadu dat, musíte ji procházet pomocí adresy URL vrácené v @odata.nextLink.

Metody HTTP

Microsoft Graph na vašem požadavku používá metodu HTTP k určení toho, co váš požadavek dělá. Rozhraní API podporuje následující metody.

metoda	Popis
GET	Čtení dat z prostředku
POST	Vytvořte nový prostředek nebo proveďte akci.
PATCH	Aktualizujte prostředek novými hodnotami.
PUT	Nahraďte prostředek novým.
DELETE	Odeberte prostředek.

Pro metody GET CRUD a DELETEnení vyžadován žádný text požadavku.
Funkce POST, PATCHa PUT metody vyžadují text požadavku zadaný ve formátu JSON, který obsahuje další informace. Například hodnoty vlastností prostředku.

Verze

Microsoft Graph aktuálně podporuje dvě verze: v1.0 a beta.

v1.0 zahrnuje obecně dostupná rozhraní API. Pro všechny produkční aplikace použijte verzi v1.0.
beta zahrnuje rozhraní API, která jsou aktuálně ve verzi Preview. Vzhledem k tomu, že můžeme do našich beta rozhraní API zavést zásadní změny, doporučujeme používat beta verzi pouze k testování aplikací, které jsou ve vývoji; nepoužívejte v produkčních aplikacích beta rozhraní API.

Prostředek

Prostředek může být entita nebo komplexní typ, běžně definovaný s vlastnostmi. Entity se liší od komplexních typů tím, že vždy zahrnují vlastnost ID .

Vaše adresa URL obsahuje prostředek, se kterým v požadavku pracujete, například meuživatel, skupina, jednotka a web. Prostředky nejvyšší úrovně často zahrnují také relace, které můžete použít pro přístup k jiným prostředkům, například me/messages nebo me/drive. S prostředky můžete také pracovat pomocí metod, například odeslat e-mail, použít me/sendMail.

Každý prostředek může pro přístup k prostředku vyžadovat různá oprávnění. K vytvoření nebo aktualizaci prostředku často potřebujete vyšší úroveň oprávnění, než je číst. Podrobnosti o požadovanýchoprávněních

Parametry dotazů

Parametry dotazu můžou být možnosti systémového dotazu OData nebo jiné řetězce, které metoda přijme k přizpůsobení odpovědi.

Volitelné možnosti systémového dotazu OData můžete použít k zahrnutí více nebo méně vlastností než výchozí odpověď. Odpověď můžete filtrovat pro položky, které odpovídají vlastnímu dotazu, nebo zadat jiné parametry pro metodu.

Například přidáním následujícího filter parametru omezíte zprávy vrácené emailAddress vlastností jon@contoso.com.

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

Další prostředky

Následují odkazy na některé nástroje, které můžete použít k vytváření a testování požadavků pomocí rozhraní Microsoft Graph API.