Aktualizowanie interfejsu API raportów dla komercyjnej platformy handlowej

Ten interfejs API ułatwia modyfikowanie parametru raportu.

Składnia żądania

Method	Identyfikator URI żądania
ODŁÓŻ	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

Nagłówek żądania

Nagłówek	Type	Opis
Autoryzacja	string	Wymagany. Token dostępu firmy Microsoft Entra w formularzu Bearer <token>
Typ zawartości	string	Application/JSON

Parametr ścieżki

Brak

Parametr zapytania

Nazwa parametru	Wymagania	Type	Opis
reportId	Tak	string	Identyfikator modyfikowanego raportu

Ładunek żą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	Wymagania	opis	Dozwolone wartości
ReportName	Tak	Nazwa, która ma zostać przypisana do raportu	string
Description	Nie	Opis utworzonego raportu	string
StartTime	Tak	Sygnatura czasowa, po której rozpocznie się generowanie raportu	string
RecurrenceInterval	Nie	Częstotliwość generowania raportu w godzinach. Wartość minimalna to 4	integer
RecurrenceCount	Nie.	Liczba raportów do wygenerowania. Wartość domyślna to nieokreślony	integer
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	string
CallbackMethod	Nie	Get/Post, metoda, 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. Format powinien mieć format rrrr-MM-ddTHH:mm:ssZ	string

Słownik

Brak

Response

Ł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: rrrr-MM-ddTHH:mm:ssZ
ModifiedTime	Czas UTC ostatniej modyfikacji raportu w tym formacie: rrrr-MM-ddTHH:mm:ssZ
ExecuteNow	Parametr ExecuteNow podany w ładunku żą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 wartość "True"
queryEndTime	Czas zakończenia zapytania podany w ładunku żądania podczas tworzenia raportu. Ma to zastosowanie tylko wtedy, gdy ExecuteNow jest ustawiona wartość "True"
StartTime	Godzina rozpoczęcia podana w ładunku żądania podczas tworzenia raportu
ReportStatus	Stan wykonania raportu. Możliwe wartości to Wstrzymane, Aktywne i Nieaktywne.
RecurrenceInterval	Interwał cyklu podany w ładunku żądania podczas tworzenia raportu
RecurrenceCount	Pozostała liczba cykli 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 wartość "True"
TotalRecurrenceCount	RecurrenceCount podany 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 stanie z wykonania interfejsu API