Freigeben über

Aktualisieren der Berichts-API für Microsoft Marketplace

Diese API hilft Ihnen beim Ändern eines Berichtsparameters.

Anforderungssyntax

Methode Anforderungs-URI
PUT https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

Anforderungsheader

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

Path-Parameter

Nichts

Abfrageparameter

Parametername Erforderlich Typ Description
reportId Yes Schnur ID des zu ändernden Berichts

Anforderungsnutzlast

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string"
}

Glossar-

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

Parameter Erforderlich Description Zulässige Werte
ReportName Yes Name, der dem Bericht zugewiesen werden soll Schnur
Description Nein Beschreibung des erstellten Berichts Schnur
StartTime Yes Zeitstempel, nach dem die Berichterstellung beginnt Schnur
RecurrenceInterval Nein Häufigkeit, mit der der Bericht in Stunden generiert werden soll. Der Mindestwert ist 4. Integer
RecurrenceCount Nein Anzahl der zu generierenden Berichte. Der Standardwert ist unbegrenzt. Integer
Format Yes Dateiformat der exportierten Datei. Der Standardwert ist CSV. CSV/TSV
CallbackUrl Yes https-Callback-URL, die bei der Berichtserstellung aufgerufen werden soll Schnur
CallbackMethod Nein Get/Post-Methode, die mit der Rückruf-URL konfiguriert werden kann GET/POST
endTime Nein UTC-Zeitstempel, an dem die Berichterstellung beendet wird. Das Format sollte yyyy-MM-ddTHH:mm:ssZ sein Schnur

Glossar-

Nichts

Antwort

Die Antwortnutzlast ist wie folgt 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-

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
  • Last updated on