Microsoft Market için rapor API'sini alma

Bu API zamanlanmış tüm raporları alır.

İstek sözdizimi

Yöntemi	İstek URI'si
AL	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

İstek başlığı

Üst Bilgi	Tür	Açıklama
İzin	dizgi	Gerekli. Microsoft Entra erişim belirteci, Bearer <token> biçiminde
İçerik Türü	dizgi	Application/JSON

yol parametresi

Hiç kimse

sorgu parametresi

Parametre Adı	Gerekli	Tür	Açıklama
reportId	Hayır	dizgi	Bu parametrede belirtilen reportId'ı içeren yalnızca raporların ayrıntılarını görmek için filtreleyin. Birden çok reportId noktalı virgülle ayrılarak belirtilebilir (;)
reportName	Hayır	dizgi	Yalnızca bu bağımsız değişkende verilen reportName içeren raporların ayrıntılarını almak için filtreleyin
queryId	Hayır	Boolean	Yanıta önceden tanımlanmış sistem sorguları ekleme

Sözlük

Hiç kimse

Yanıt

Yanıt yükü aşağıdaki gibi JSON biçiminde yapılandırılmıştır:

Yanıt kodu: 200, 400, 401, 403, 404, 500

Yanıt yükü:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      " RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Sözlük

Bu tabloda yanıttaki öğelerin temel tanımları listelenmiştir.

Parametre	Açıklama
ReportId	Oluşturduğunuz raporun evrensel olarak benzersiz tanımlayıcısı (UUID)
ReportName	Rapor oluşturma sırasında istek yükünde sağlanan ad
Description	Rapor oluşturulurken istek yükünde belirtilen açıklama
QueryId	Rapor oluşturma sırasında istek yükünde sağlanan sorgu kimliği
Query	Bu rapor için yürütülecek sorgu metni
User	Raporu oluşturmak için kullanılan kullanıcı kimliği
CreatedTime	UTC Raporun bu biçimde oluşturulduğu saat: yyyy-MM-ddTHH:mm:ssZ
ModifiedTime	UTC Raporun son değiştirildiği saat: yyyy-MM-ddTHH:mm:ssZ
ExecuteNow	Rapor oluşturma sırasında istek yükünde sağlanan ExecuteNow parametresi
queryStartTime	Rapor oluşturma sırasında istek yükünde sağlanan sorgu başlangıç zamanı. Bu yalnızca ExecuteNow "True" olarak ayarlandığında geçerlidir
queryEndTime	Rapor oluşturma sırasında istek yükünde sağlanan sorgu bitiş zamanı. Bu yalnızca ExecuteNow "True" olarak ayarlandığında geçerlidir
StartTime	Rapor oluşturma sırasında istek yükünde sağlanan başlangıç zamanı
ReportStatus	Rapor gerçekleştirilmesinin durumu. Olası değerler Duraklatıldı, Etkinve Etkin Değil.
RecurrenceInterval	Rapor oluşturma sırasında istek yükünde sağlanan yineleme aralığı
RecurrenceCount	Rapor için kalan yinelenme sayısı
CallbackUrl	Rapor oluşturma sırasında istek yükünde sağlanan callback URL
CallbackMethod	Rapor oluşturma sırasında istek yükünde sağlanan geri çağırma yöntemi
Format	Rapor oluşturma sırasında istek yükünde sağlanan rapor dosyalarının biçimi
EndTime	Rapor oluşturma sırasında istek yükünde sağlanan bitiş zamanı. Bu yalnızca ExecuteNow "True" olarak ayarlandığında geçerlidir
TotalRecurrenceCount	rapor oluşturma sırasında istek yükünde sağlanan RecurrenceCount
nextExecutionStartTime	Bir sonraki rapor yürütmenin ne zaman başlayacağına ilişkin UTC zaman damgası
TotalCount	Değer dizisindeki kayıt sayısı
StatusCode	Sonuç Kodu. Olası değerler 200, 400, 401, 403, 500'dür
message	API'nin yürütülmesinden gelen durum iletisi