Abrufen der Berichts-API für den kommerziellen Marketplace

Diese API ruft alle Berichte ab, die geplant wurden.

Anforderungssyntax

Methode	Anforderungs-URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

Anforderungsheader

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

Path-Parameter

Nichts

Abfrageparameter

Parametername	Erforderlich	Typ	Beschreibung
reportId	Nein	Schnur	Filtern Sie, um Details zu nur Berichten mit dem reportId in diesem Argument angegebenen abzurufen. Mehrere reportId können angegeben werden, indem sie durch Semikolon getrennt werden (;)
reportName	Nein	Schnur	Filtern, um Details zu nur Berichten mit dem reportName in diesem Argument angegebenen abzurufen
queryId	Nein	boolean	Einschließen vordefinierter Systemabfragen in die Antwort

Glossar-

Nichts

Antwort

Die Antwortnutzlast ist wie folgt im JSON-Format strukturiert:

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

Antwortnutzlast:

{
  "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
}

Glossar-

In dieser Tabelle sind die wichtigsten Definitionen von Elementen in der Antwort aufgeführt.

Parameter	Description
ReportId	Universally Unique Identifier (UUID) des erstellten Berichts
ReportName	Name, der während der Berichtserstellung in der Anforderungsnutzlast angegeben wird
Description	Beschreibung, die in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt wird
QueryId	Abfrage-ID, die während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt wird
Query	Abfragetext, der für diesen Bericht ausgeführt wird
User	Benutzer-ID zum Erstellen des Berichts
CreatedTime	UTC-Zeit, zu der der Bericht in diesem Format erstellt wurde: yyyy-MM-ddTHH:mm:ssZ
ModifiedTime	UTC-Zeit, zu der der Bericht zuletzt in diesem Format geändert wurde: yyyy-MM-ddTHH:mm:ssZ
ExecuteNow	ExecuteNow-Parameter, der während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt wird
queryStartTime	Abfragestartzeit, die in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt wird. Dies gilt nur, wenn ExecuteNow sie auf "True" festgelegt ist.
queryEndTime	Abfrageendzeit, die in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt wird. Dies gilt nur, wenn ExecuteNow sie auf "True" festgelegt ist.
StartTime	Startzeit, die in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt wird
ReportStatus	Status der Berichtsausführung. Die möglichen Werte sind "Angehalten", "Aktiv" und "Inaktiv".
RecurrenceInterval	Wiederholungsintervall, das während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt wird
RecurrenceCount	Verbleibende Wiederholungsanzahl für den Bericht
CallbackUrl	Rückruf-URL, die während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt wird
CallbackMethod	Callbackmethode, die während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt wird
Format	Format der Berichtsdateien, die während der Berichtserstellung in der Anforderungsnutzlast bereitgestellt werden
EndTime	Endzeit, die in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt wird. Dies gilt nur, wenn ExecuteNow sie auf "True" festgelegt ist.
TotalRecurrenceCount	RecurrenceCount in der Anforderungsnutzlast während der Berichtserstellung bereitgestellt
nextExecutionStartTime	UTC-Zeitstempel, wenn die ausführung des nächsten Berichts gestartet wird
TotalCount	Anzahl der Datensätze im Wertarray
StatusCode	Ergebniscode. Die möglichen Werte sind 200, 400, 401, 403, 500
message	Statusmeldung aus der Ausführung der API