Abrufen der Berichtsabfrage-API für den kommerziellen Marketplace

Mit der API zum Abrufen von Berichtsabfragen werden alle Abfragen abgerufen, die in Berichten verwendet werden können. Es werden standardmäßig alle Systemabfragen und benutzerdefinierten Abfragen abgerufen.

Anforderungssyntax

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

Anforderungsheader

Übergeordnet	Typ	Beschreibung
Autorisierung	Zeichenfolge	Erforderlich. Das Microsoft Entra-Zugriffstoken im Formular Bearer <token>
Content-Type	Zeichenfolge	Application/JSON

Pfadparameter

Keine

Abfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
queryId	Zeichenfolge	No	Filter, um nur Details zu Abfragen mit der in diesem Argument angegebenen ID abzurufen
queryName	Zeichenfolge	No	Filter, um nur Details zu Abfragen mit dem in diesem Argument angegebenen Namen abzurufen
IncludeSystemQueries	boolean	Nein	Fügen Sie vordefinierte Systemabfragen in die Antwort ein. Standardwert ist true.
IncludeOnlySystemQueries	boolean	Nein	Fügen Sie nur Systemabfragen in die Antwort ein. Standardwert ist "False".

Anforderungsnutzlast

Keine

Glossar

Keine

Antwort

Die Antwortnutzdaten sind wie folgt strukturiert:

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

Antwortnutzlast:

{
  "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 Schlüsseldefinitionen der Elemente in der Antwort beschrieben.

Parameter	Beschreibung
QueryId	Eindeutige UUID der Abfrage
Name	Der Name, der der Abfrage bei ihrer Erstellung gegeben wurde
Description	Die Beschreibung, die der Abfrage bei ihrer Erstellung hinzugefügt wurde
Query	Zeichenfolge der Berichtsabfrage
Type	Für von Benutzern erstellte Abfragen auf userDefined und für vordefinierte Systemabfragen auf system festlegen
User	ID des Benutzers, der die Abfrage erstellt hat
CreatedTime	Zeitpunkt der Erstellung der Abfrage
TotalCount	Anzahl von Datasets im Wertarray
StatusCode	Ergebniscode. Die möglichen Werte sind 200, 400, 401, 403, 500.