Rapport-API bijwerken

Artikel
06/29/2024

Met deze API kunt u een rapportparameter wijzigen.

Aanvraagsyntaxis

Wijze	Aanvraag-URI
PUT	`https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/{Report ID}`

Aanvraagheader

Koptekst	Type	Description
Autorisatie	tekenreeks	Vereist. Het Microsoft Entra-toegangstoken in het formulier `Bearer <token>`
Inhoudstype	tekenreeks	`Application/JSON`

Padparameter

Parameternaam	Type	Vereist	Beschrijving
reportId	tekenreeks	Nee	Id van het rapport dat wordt gewijzigd

Queryparameter

Geen

Nettolading aanvragen

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

Woordenlijst aanvragen

Deze tabel bevat de belangrijkste definities van elementen in het antwoord.

Parameter	Vereist	Beschrijving	Toegestane waarden
ReportName	Ja	Naam die moet worden toegewezen aan het rapport	String
Beschrijving	Nee	Beschrijving van het gemaakte rapport	String
StartTime	Ja	Tijdstempel waarna het genereren van het rapport begint	String
RecurrenceInterval	Nee	Frequentie waarmee het rapport in uren moet worden gegenereerd. Minimumwaarde is 4	Geheel getal
RecurrenceCount	Nee	Aantal te genereren rapporten. De standaardwaarde is voor onbepaalde tijd.	Geheel getal
Notatie	Nee	Bestandsindeling van het geëxporteerde bestand. Standaard is CSV	CSV/TSV
CallbackURL	Nee	https callback-URL die moet worden aangeroepen bij het genereren van rapporten	String
CallbackMethod	Nee	Http-methode die moet worden gebruikt voor callback	GET/POST

Respons

De nettolading van het antwoord is als volgt gestructureerd:

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

Voorbeeld van nettolading van antwoord:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "ExecuteNow": true,
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "CallbackMethod": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

Woordenlijst voor antwoorden

In deze tabel worden de belangrijkste elementen in het antwoord gedefinieerd:

Parameter	Description
ReportId	UUID (Universally Unique Identifier) van het rapport dat wordt bijgewerkt
ReportName	Naam gegeven aan het rapport in de nettolading van de aanvraag
Beschrijving	Beschrijving van het rapport in de nettolading van de aanvraag
QueryId	Query-id doorgegeven op het moment dat het rapport is gemaakt
Query	Querytekst die wordt uitgevoerd voor dit rapport
User	Gebruikers-id die wordt gebruikt om het rapport te maken
CreatedTime	Tijdstip waarop het rapport is gemaakt. De tijdnotatie is jjjj-MM-ddTHH:mm:ssZ
ModifiedTime	Tijdstip waarop het rapport voor het laatst is gewijzigd. De tijdnotatie is jjjj-MM-ddTHH:mm:ssZ
ExecuteNow	ExecuteNow-vlag ingesteld op het moment dat het rapport is gemaakt
StartTime	Tijd waarop de uitvoering van het rapport begint. De tijdnotatie is jjjj-MM-ddTHH:mm:ssZ
ReportStatus	Status van de uitvoering van het rapport. De mogelijke waarden zijn onderbroken, actief en inactief.
RecurrenceInterval	Herhalingsinterval opgegeven in de nettolading van de aanvraag
RecurrenceCount	Aantal terugkeerpatronen dat is opgegeven in de nettolading van de aanvraag
CallbackUrl	Callback-URL die is opgegeven in de aanvraag
CallbackMethod	Callback-methode die is opgegeven in de aanvraag
Notatie	Indeling van de rapportbestanden
TotalCount	Aantal gegevenssets in de waardematrix
Bericht	Statusbericht van de uitvoering van de API
StatusCode	Resultaatcode. De mogelijke waarden zijn 200, 400, 401, 403, 500

Delen via