Freigeben über

Abrufen der Berichtsabfrage-API für den kommerziellen Marketplace

Die API zum Abrufen von Berichtsabfragen ruft alle Abfragen ab, die für die Verwendung in Berichten verfügbar sind. Es ruft standardmäßig alle system- und benutzerdefinierten Abfragen ab.

Syntax der Anforderung

Methode Anforderungs-URI
ERHALTEN/Bekommen https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Anforderungsheader

Überschrift Typ Beschreibung
Autorisierung Schnur Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>
Inhaltstyp Schnur Application/JSON

Pfadparameter

Nichts

Abfrageparameter

Parametername Typ Erforderlich Beschreibung
queryId Schnur Nein Filtern, um Details zu nur Abfragen mit der im Argument angegebenen ID abzurufen
queryName Schnur Nein Filtern, um Details nur von Abfragen mit dem im Argument angegebenen Namen abzurufen
IncludeSystemQueries Boolescher Wert Nein Fügen Sie vordefinierte Systemabfragen in die Antwort ein. Der Standardwert ist True.
IncludeOnlySystemQueries Boolescher Wert Nein Schließen Sie nur Systemabfragen in die Antwort ein. Der Standardwert ist False

Nutzlast anfordern

Nichts

Glossar

Nichts

Antwort

Die Antwortnutzlast ist wie folgt strukturiert:

Antwortcode: 200, 400, 401, 403, 404, 500

Nutzlast der Antwort:

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

Glossar

In dieser Tabelle werden die wichtigsten Definitionen der Elemente in der Antwort beschrieben.

Parameter Beschreibung
QueryId Eindeutige UUID der Abfrage
Name Name der Abfrage zum Zeitpunkt der Abfrageerstellung
Description Beschreibung, die während der Erstellung der Abfrage angegeben wird
Query Berichtsabfragezeichenfolge
Type Für benutzerdefinierte Abfragen und userDefined für vordefinierte Systemabfragen auf system festlegen
User Benutzer-ID, die die Abfrage erstellt hat
CreatedTime Zeitpunkt der Erstellung einer Abfrage
TotalCount Anzahl der Datasets im Value-Array
StatusCode Ergebniscode. Die möglichen Werte sind 200, 400, 401, 403, 500
  • Last updated on