Udostępnij przez

Aktualizowanie interfejsu API raportów dla witryny Microsoft Marketplace

Ten interfejs API ułatwia modyfikowanie parametru raportu.

Składnia żądania

Metoda Identyfikator URI żądania
KŁAŚĆ https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

Nagłówek żądania

Nagłówek Typ Opis
Autoryzacja ciąg Wymagane. Token dostępu Microsoft Entra w postaci Bearer <token>
Typ zawartości ciąg Application/JSON

parametr ścieżki

Żaden

parametr zapytania

Nazwa parametru Wymagane Typ Opis
reportId Tak ciąg Identyfikator modyfikowanego raportu

Treść żądania

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string"
}

słownik

W tej tabeli wymieniono kluczowe definicje elementów w ładunku żądania.

Parametr Wymagane Opis Dozwolone wartości
ReportName Tak Nazwa, która ma zostać przypisana do raportu ciąg
Description Nie Opis utworzonego raportu ciąg
StartTime Tak Sygnatura czasowa, po której rozpocznie się generowanie raportu ciąg
RecurrenceInterval Nie Częstotliwość generowania raportu w godzinach. Wartość minimalna to 4 liczba całkowita
RecurrenceCount Nie Liczba raportów do wygenerowania. Wartość domyślna to nieokreślona liczba całkowita
Format Tak Format pliku wyeksportowanego. Wartość domyślna to CSV. CSV/TSV
CallbackUrl Tak adres URL wywołania zwrotnego https, który ma być wywoływany podczas generowania raportu ciąg
CallbackMethod Nie Metoda GET/POST, którą można skonfigurować przy użyciu adresu URL wywołania zwrotnego GET/POST
endTime Nie Sygnatura czasowa UTC, na której zakończy się generowanie raportu. Zapis powinien mieć format rrrr-MM-ddTHH:mm:ssZ ciąg

słownik

Żaden

odpowiedzi

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

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

Ładunek odpowiedzi:

{
  "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łownik

Parametr Opis
ReportId Unikatowy identyfikator (UUID) utworzonego raportu
ReportName Nazwa podana w ładunku żądania podczas tworzenia raportu
Description Opis podany w ładunku żądania podczas tworzenia raportu
QueryId Identyfikator zapytania podany w ładunku żądania podczas tworzenia raportu
Query Tekst zapytania, który zostanie wykonany dla tego raportu
User Identyfikator użytkownika używany do tworzenia raportu
CreatedTime Czas UTC utworzenia raportu w tym formacie: yyyy-MM-ddTHH:mm:ssZ
ModifiedTime Czas UTC ostatniej modyfikacji raportu w tym formacie: rrrr-MM-ddTHH:mm:ssZ
ExecuteNow Parametr „WykonajTeraz” podany w treści żądania podczas tworzenia raportu
queryStartTime Czas rozpoczęcia zapytania podany w ładunku żądania podczas tworzenia raportu. Ma to zastosowanie tylko wtedy, gdy ExecuteNow jest ustawiona na wartość "True"
queryEndTime Czas zakończenia zapytania podany w ładunku żądania podczas tworzenia raportu. Ma to zastosowanie tylko wtedy, gdy ExecuteNow jest ustawiona na wartość "True"
StartTime Godzina rozpoczęcia podana w ładunku żądania podczas tworzenia raportu
ReportStatus Stan wykonania raportu. Możliwe wartości to Wstrzymane, Aktywnei Nieaktywne.
RecurrenceInterval Przedział powtarzalności podany w treści żądania podczas tworzenia raportu
RecurrenceCount Pozostała liczba powtórzeń dla raportu
CallbackUrl Adres URL wywołania zwrotnego podany w ładunku żądania podczas tworzenia raportu
CallbackMethod Metoda wywołania zwrotnego podana w ładunku żądania podczas tworzenia raportu
Format Format plików raportu podanych w ładunku żądania podczas tworzenia raportu
EndTime Godzina zakończenia podana w ładunku żądania podczas tworzenia raportu. Ma to zastosowanie tylko wtedy, gdy ExecuteNow jest ustawiona na wartość "True"
TotalRecurrenceCount RecurrenceCount podane w ładunku żądania podczas tworzenia raportu
nextExecutionStartTime Sygnatura czasowa UTC, kiedy rozpocznie się następne wykonanie raportu
TotalCount Liczba rekordów w tablicy Value
StatusCode Kod wyniku. Możliwe wartości to 200, 400, 401, 403, 500
message Komunikat o statusie wykonania interfejsu API
  • Last updated on