Udostępnij przez

Uzyskiwanie interfejsu API zapytań dotyczących raportów dla witryny Microsoft Marketplace

Interfejs API do pobierania zapytań raportów uzyskuje wszystkie zapytania, które są dostępne do użycia w raportach. Domyślnie pobiera wszystkie zapytania systemowe i zdefiniowane przez użytkownika.

Składnia żądania

metoda identyfikator URI żądania
POBIERZ https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Nagłówek żądania

nagłówek typu 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 typu wymagane opis
queryId ciąg Nie Filtruj, aby uzyskać szczegółowe informacje dotyczące tylko zapytań o identyfikatorze podanym w argumencie
queryName ciąg Nie Filtruj, aby uzyskać szczegółowe informacje o tylko zapytaniach o nazwie podanej w argumencie
IncludeSystemQueries logiczny Nie Uwzględnij wstępnie zdefiniowane zapytania systemowe w odpowiedzi. Wartość domyślna to True.
IncludeOnlySystemQueries logiczny Nie Uwzględnij tylko zapytania systemowe w odpowiedzi. Wartość domyślna to False

ładunek żądania

Żaden

słownik

Żaden

odpowiedź

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

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

Ładunek odpowiedzi:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

słownik

W tej tabeli opisano kluczowe definicje elementów w odpowiedzi.

parametru opis
QueryId Unikatowy identyfikator UUID zapytania
Name Nazwa nadana kwerendzie w momencie tworzenia zapytania
Description Opis podany podczas tworzenia zapytania
Query Ciąg zapytania dla raportu
Type Ustaw wartość userDefined dla zapytań utworzonych przez użytkownika i system dla wstępnie zdefiniowanych zapytań systemowych
User Identyfikator użytkownika, który utworzył zapytanie
CreatedTime Czas tworzenia zapytania
TotalCount Liczba zestawów danych w tablicy Value
StatusCode Kod wyniku. Możliwe wartości to 200, 400, 401, 403, 500
  • Last updated on