Aggiornare l'API del report per il marketplace commerciale

Questa API consente di modificare un parametro del report.

Sintassi della richiesta

metodo	URI della richiesta
PUT	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

Intestazione della richiesta

Intestazione	Type	Descrizione
Autorizzazione	stringa	Obbligatorio. Token di accesso Di Microsoft Entra nel modulo Bearer <token>
Content-Type	string	Application/JSON

Parametro Path

None

Parametro di query

Nome parametro	Richiesto	Type	Descrizione
reportId	Sì	string	ID del report da modificare

Payload della richiesta

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

Glossario

Questa tabella elenca le definizioni chiave degli elementi nel payload della richiesta.

Parametro	Richiesto	Descrizione	Valori consentiti
ReportName	Sì	Nome da assegnare al report	string
Description	No	Descrizione del report creato	string
StartTime	Sì	Timestamp dopo il quale inizierà la generazione del report	string
RecurrenceInterval	No	Frequenza con cui deve essere generato il report in ore. Il valore minimo è 4	integer
RecurrenceCount	No	Numero di report da generare. Il valore predefinito è indefinito	integer
Format	Sì	Formato di file del file esportato. Il valore predefinito è CSV.	CSV/TSV
CallbackUrl	Sì	URL di callback https da chiamare per la generazione di report	string
CallbackMethod	No	Metodo Get/Post che può essere configurato con l'URL di callback	GET/POST
endTime	No	Timestamp UTC in corrispondenza del quale terminerà la generazione del report. Il formato deve essere aa-MM-ggTHH:mm:ssZ	string

Glossario

None

Response

Il payload della risposta è strutturato come segue:

Codice risposta: 200, 400, 401, 403, 404, 500

Payload della risposta:

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

Glossario

Parametro	Descrizione
ReportId	Identificatore univoco universale (UUID) del report creato
ReportName	Nome specificato nel payload della richiesta durante la creazione del report
Description	Descrizione fornita nel payload della richiesta durante la creazione del report
QueryId	ID query fornito nel payload della richiesta durante la creazione del report
Query	Testo della query che verrà eseguito per questo report
User	ID utente usato per creare il report
CreatedTime	Ora UTC in cui è stato creato il report in questo formato: aa-MM-ggTHH:mm:ssZ
ModifiedTime	Ora UTC dell'ultima modifica apportata al report in questo formato: aaaa-MM-ggTHH:mm:ssZ
ExecuteNow	Parametro ExecuteNow fornito nel payload della richiesta durante la creazione del report
queryStartTime	Ora di inizio della query specificata nel payload della richiesta durante la creazione del report. Questo è applicabile solo se ExecuteNow è impostato su "True"
queryEndTime	Ora di fine della query specificata nel payload della richiesta durante la creazione del report. Questo è applicabile solo se ExecuteNow è impostato su "True"
StartTime	Ora di inizio specificata nel payload della richiesta durante la creazione del report
ReportStatus	Stato dell'esecuzione del report. I valori possibili sono Paused, Active e Inactive.
RecurrenceInterval	Intervallo di ricorrenza specificato nel payload della richiesta durante la creazione del report
RecurrenceCount	Numero di ricorrenze rimanenti per il report
CallbackUrl	URL di callback fornito nel payload della richiesta durante la creazione del report
CallbackMethod	Metodo di callback fornito nel payload della richiesta durante la creazione del report
Format	Formato dei file di report forniti nel payload della richiesta durante la creazione del report
EndTime	Ora di fine specificata nel payload della richiesta durante la creazione del report. Questo è applicabile solo se ExecuteNow è impostato su "True"
TotalRecurrenceCount	RecurrenceCount specificato nel payload della richiesta durante la creazione del report
nextExecutionStartTime	Timestamp UTC all'avvio dell'esecuzione successiva del report
TotalCount	Numero di record nella matrice Value
StatusCode	Codice risultato. I valori possibili sono 200, 400, 401, 403, 500
message	Messaggio di stato dall'esecuzione dell'API