Aktualisieren der Berichts-API für den kommerziellen Marketplace

Mit dieser API können Sie einen Berichtsparameter ändern.

Anforderungssyntax

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

Anforderungsheader

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

Pfadparameter

Keine

Abfrageparameter

Parametername	Erforderlich	Type	BESCHREIBUNG
reportId	Ja	Zeichenfolge	ID des Berichts, der geändert wird

Anforderungsnutzlast

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

Glossar

In dieser Tabelle sind die Schlüsseldefinitionen der Elemente in den Anforderungsnutzdaten aufgeführt.

Parameter	Erforderlich	Beschreibung	Zulässige Werte
ReportName	Ja	Name, der dem Bericht zugewiesen werden soll	Zeichenfolge
Description	No	Beschreibung des erstellten Berichts	Zeichenfolge
StartTime	Ja	Zeitstempel, nach dem die Berichterstellung beginnt	Zeichenfolge
RecurrenceInterval	No	Häufigkeit in Stunden, mit der der Bericht generiert werden soll. Der Mindestwert ist 4.	integer
RecurrenceCount	No	Anzahl der zu generierenden Berichte. Der Standardwert ist „Unbestimmt“.	integer
Format	Ja	Dateiformat für die exportierte Datei. Der Standardwert ist „CSV“.	CSV/TSV
CallbackUrl	Ja	HTTPS-Rückruf-URL, die bei der Berichterstellung aufgerufen werden soll	Zeichenfolge
CallbackMethod	No	Get/Post-Methode, die mit der Rückruf-URL konfiguriert werden kann	GET/POST
endTime	No	UTC-Zeitstempel, an dem die Berichterstellung beendet wird. Das Format sollte wie folgt lauten: yyyy-MM-ddTHH:mm:ssZ.	Zeichenfolge

Glossar

Keine

Antwort

Die Antwortnutzdaten sind 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	Beschreibung
ReportId	Universally Unique Identifier (UUID) des von Ihnen 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, die zum Erstellen des Berichts verwendet wird
CreatedTime	Die UTC-Zeit, zu der der Bericht erstellt wurde, im folgenden Format: yyyy-MM-ddTHH:mm:ssZ
ModifiedTime	Die UTC-Zeit, zu der der Bericht zuletzt geändert wurde, im folgenden Format: 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 lauten 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 Value-Array
StatusCode	Ergebniscode. Die möglichen Werte sind 200, 400, 401, 403, 500.
message	Statusmeldung der API-Ausführung