Udostępnij przez

Usuwanie interfejsu API raportu dla komercyjnej platformy handlowej

Po wykonaniu ten interfejs API usuwa wszystkie raporty i rekordy wykonywania raportów.

Składnia żądania

Metoda Żądanie URI
USUNĄĆ 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 formie Bearer <token>
Typ zawartości ciąg Application/JSON

parametr ścieżki

Żaden

Parametr zapytania

Nazwa parametru Wymagane ciąg Opis
reportId Tak ciąg Identyfikator raportu, który jest modyfikowany

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: 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 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 treści żądania przy tworzeniu raportu
ReportStatus Stan wykonania raportu. Możliwe wartości to Wstrzymane, Aktywnei Nieaktywne.
RecurrenceInterval Interwał cyklu podany w ładunku żą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 treści żądania podczas tworzenia raportu
Format Format plików raportu podanych w ładunku żądania podczas tworzenia raportu
EndTime Godzina zakończenia podana w treści żą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