REST kullanarak Microsoft Graph'i sorgulama

Tamamlandı

Microsoft Graph, Microsoft Bulut hizmeti kaynaklarına erişmenizi sağlayan bir RESTful web API'dir. Uygulamanızı kaydettikten ve bir kullanıcı veya hizmet için kimlik doğrulama belirteçleri aldıktan sonra Microsoft Graph API'sine istekte bulunabilirsiniz.

Microsoft Graph API'si kaynaklarının, yöntemlerinin ve numaralandırmalarının çoğunu Microsoft Graph meta verilerinde OData ad alanında microsoft.graphtanımlar. içinde callRecord gibi kaynakları tanımlayan çağrı kayıtları API'si gibi birkaç API kümesi kendi alt ad alanında tanımlanır. microsoft.graph.callRecords

İlgili konuda açıkça belirtilmediği sürece türlerin, yöntemlerin ve numaralandırmaların ad alanının bir parçası microsoft.graph olduğunu varsayalım.

REST API yöntemi çağırma

Kullanıcı veya e-posta iletisi gibi bir kaynaktan okumak veya bu kaynağa yazmak için aşağıdakine benzer bir istek oluşturun:

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

İsteğin bileşenleri şunlardır:

  • {HTTP method} - Microsoft Graph isteğinde kullanılan HTTP yöntemi.
  • {version} - Uygulamanızın kullandığı Microsoft Graph API sürümü.
  • {resource} - Microsoft Graph'ta başvurduğunuz kaynak.
  • {query-parameters} - yanıtı özelleştiren isteğe bağlı OData sorgu seçenekleri veya REST yöntemi parametreleri.

bir istekte bulunarak aşağıdakiler içeren bir yanıt döndürülür:

  • Durum kodu - Başarılı veya başarısız olduğunu gösteren bir HTTP durum kodu.
  • Yanıt iletisi - İstediğiniz veriler veya işlemin sonucu. Yanıt iletisi bazı işlemler için boş olabilir.
  • nextLink - İsteğiniz çok sayıda veri döndürüyorsa, içinde @odata.nextLinkdöndürülen URL'yi kullanarak sayfalandırmanız gerekir.

HTTP yöntemleri

Microsoft Graph, isteğinizin ne yaptığını belirlemek için isteğinizdeki HTTP yöntemini kullanır. API aşağıdaki yöntemleri destekler.

Metot Açıklama
GET Bir kaynaktan verileri okuma.
POST Yeni bir kaynak oluşturun veya bir eylem gerçekleştirin.
PATCH Kaynağı yeni değerlerle güncelleştirin.
PUT Bir kaynağı yenisiyle değiştirin.
SİL Kaynağı kaldırma.
  • CRUD yöntemleri ve DELETEiçin GET istek gövdesi gerekmez.
  • POST, PATCHve PUT yöntemleri, ek bilgiler içeren JSON biçiminde belirtilen bir istek gövdesi gerektirir. Kaynağın özellikleri için değerler gibi.

Sürüm

Microsoft Graph şu anda iki sürümü destekler: v1.0 ve beta.

  • v1.0 genel kullanılabilir API'leri içerir. Tüm üretim uygulamaları için v1.0 sürümünü kullanın.
  • beta şu anda önizleme aşamasında olan API'leri içerir. Beta API'lerimizde hataya neden olan değişikliklere neden olabileceğimizden, beta sürümünü yalnızca geliştirme aşamasında olan uygulamaları test etmek için kullanmanızı öneririz; üretim uygulamalarınızda beta API'leri kullanmayın.

Kaynak

Kaynak, genellikle özelliklerle tanımlanan bir varlık veya karmaşık tür olabilir. Varlıklar, her zaman bir kimlik özelliği ekleyerek karmaşık türlerden farklıdır.

URL'niz istekte etkileşimde olduğunuz kaynağı (kullanıcı, grup, sürücü ve site gibime) içerir. Üst düzey kaynaklar genellikle veya gibi me/messages diğer kaynaklara erişmek için kullanabileceğiniz ilişkileri de içerir.me/drive Ayrıca yöntemleri kullanarak kaynaklarla etkileşimde de bulunabilirsiniz; örneğin, e-posta göndermek için kullanınme/sendMail.

Her kaynağın erişmesi için farklı izinler gerekebilir. Genellikle bir kaynağı oluşturmak veya güncelleştirmek için okumaktan daha yüksek bir izin düzeyine ihtiyacınız vardır. Gerekli izinler hakkında ayrıntılı bilgi için yöntem başvurusu konusuna bakın.

Sorgu parametreleri

Sorgu parametreleri OData sistem sorgu seçenekleri veya bir yöntemin yanıtını özelleştirmek için kabul ettiği diğer dizeler olabilir.

Varsayılan yanıttan daha fazla veya daha az özellik eklemek, özel sorguyla eşleşen öğeler için yanıtı filtrelemek veya bir yöntem için başka parametreler sağlamak için isteğe bağlı OData sistem sorgusu seçeneklerini kullanabilirsiniz.

Örneğin, aşağıdaki filter parametrenin eklenmesi döndürülen iletileri yalnızca özelliğine emailAddress jon@contoso.comsahip iletilerle kısıtlar.

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

Diğer kaynaklar

Aşağıda, Microsoft Graph API'lerini kullanarak istekleri derlemek ve test etmek için kullanabileceğiniz bazı araçların bağlantıları yer alır.