Uzyskiwanie interfejsu API raportu

Ten interfejs API pobiera wszystkie zaplanowane raporty.

Składnia żądania

Metoda	Identyfikator URI żądania
POBIERZ	https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

Nagłówek żądania

Nagłówek	Typ	Opis
Autoryzacja	struna	Wymagane. Token dostępu firmy Microsoft entra w formularzu Bearer <token>
Typ zawartości	struna	Application/JSON

Parametr ścieżki

Żaden

Parametr zapytania

Nazwa parametru	Typ	Wymagane	Opis
reportId	struna	Nie	Filtruj, aby uzyskać szczegółowe informacje o raportach z identyfikatorem reportId podanym w tym argumencie
reportName	struna	Nie	Filtruj, aby uzyskać szczegółowe informacje o raportach o nazwie reportName podanej w tym argumencie
queryId	struna	Nie	Filtruj, aby uzyskać szczegółowe informacje dotyczące tylko raportów z identyfikatorem queryId podanym w tym argumencie

Ładunek żądania

Żaden

Słownik żądań

Żaden

Odpowiedź

Ładunek odpowiedzi jest ustrukturyzowany w następujący sposób:

Kod odpowiedzi: 200, 400, 401, 403, 404, 500

Przykład ładunku odpowiedzi:

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

Słownik odpowiedzi

W tej tabeli zdefiniowano kluczowe elementy odpowiedzi:

Parametr	Opis
Identyfikator raportu	Unikatowy identyfikator UUID utworzonego raportu
Nazwa raportu	Nazwa nadana raportowi w ładunku żądania
Opis	Opis podany podczas tworzenia raportu
Identyfikator kwerendy	Identyfikator zapytania przekazany podczas tworzenia raportu
Zapytanie	Tekst zapytania, który zostanie wykonany dla tego raportu
Użytkownik	Identyfikator użytkownika używany do tworzenia raportu
CreatedTime	Czas utworzenia raportu. Format czasu to rrrr-MM-ddTHH:mm:ssZ
ModifiedTime	Czas ostatniej modyfikacji raportu. Format czasu to rrrr-MM-ddTHH:mm:ssZ
executeNow	Flaga ExecuteNow ustawiona podczas tworzenia raportu
Godzina rozpoczęcia	Rozpocznie się wykonywanie czasu. Format czasu to rrrr-MM-ddTHH:mm:ssZ
ReportStatus	Stan wykonania raportu. Możliwe wartości to Wstrzymane, Aktywne i Nieaktywne.
CyklInterval	Interwał cyklu udostępniany podczas tworzenia raportu
Liczba cykli	Liczba cykli podana podczas tworzenia raportu
CallbackUrl	Adres URL wywołania zwrotnego podany w żądaniu
Wywołanie zwrotneMethod	Metoda wywołania zwrotnego podana w żądaniu
Format	Format plików raportu
TotalCount	Liczba zestawów danych w tablicy Value
Komunikat	Komunikat o stanie z wykonania interfejsu API
Kod stanu	Kod wyniku. Możliwe wartości to 200, 400, 401, 403, 500