Aktualizace rozhraní API pro sestavy

Toto rozhraní API vám pomůže upravit parametr sestavy.

Syntaxe požadavku

Metoda Identifikátor URI žádosti
PUT https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/{Report ID}

Hlavička požadavku

Hlavička Typ Description
Autorizace řetězec Povinná hodnota. Přístupový Azure Active Directory služby (AAD) ve formulářiBearer <token>
Typ obsahu řetězec Application/JSON

Parametr cesty

Název parametru Typ Vyžadováno Popis
reportId řetězec No ID upravované sestavy

Parametr dotazu

Žádné

Žádost o datovou část

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

Glosář

Tato tabulka obsahuje seznam klíčových definic elementů v odpovědi.

Parametr Povinné Popis Povolené hodnoty
ReportName Yes Název, který se má k sestavě přiřadit Řetězec
Popis No Popis vytvořené sestavy Řetězec
StartTime Yes Časové razítko, po kterém začne generování sestavy Řetězec
OpakováníInterval No Frekvence generování sestavy v hodinách Minimální hodnota je 4 Integer
Počet opakování No Čísla sestav, které se budou generovat Výchozí hodnota je neurčitý. Integer
Formát No Formát exportovaného souboru Výchozí hodnota je CSV. CSV/TSV
CallbackURL No Adresa URL zpětného volání https, která se má volat při generování sestav Řetězec
Metoda zpětného volání No Metoda HTTP, která se má použít pro zpětné volání GET/POST

Response (Odpověď)

Datová část odpovědi je strukturovaná takto:

Kód odpovědi: 200, 400, 401, 403, 404, 500

Příklad datové části odpovědi:

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

Glosář

Tato tabulka definuje klíčové prvky v odpovědi:

Parametr Popis
ID sestavy Univerzálně jedinečný identifikátor (UUID) aktualizované sestavy
ReportName Název předaný sestavě v datové části požadavku
Description Popis předáný sestavě v datové části požadavku
ID dotazu ID dotazu předané v době vytvoření sestavy
Dotaz Text dotazu, který se provede pro tuto sestavu
Uživatel ID uživatele použité k vytvoření sestavy
CreatedTime Čas vytvoření sestavy Formát času je rrrr-MM-ddTHH:mm:ssZ.
ModifiedTime Čas poslední změny sestavy Formát času je rrrr-MM-ddTHH:mm:ssZ.
ExecuteNow Příznak ExecuteNow nastavený v době vytvoření sestavy
StartTime Čas, kdy se spustí spuštění sestavy. Formát času je RRRR-MM-ddTHH: mm: ssZ
ReportStatus Stav provádění sestavy Možné hodnoty jsou pozastavené, aktivní a neaktivní.
RecurrenceInterval Interval opakování zadaný v datové části požadavku
RecurrenceCount Počet opakování poskytnutý v datové části požadavku
CallbackUrl Adresa URL zpětného volání poskytnutá v žádosti
CallbackMethod Metoda zpětného volání poskytnutá v žádosti
Formát Formát souborů sestav
TotalCount Počet datových sad v poli hodnot
Zpráva Stavová zpráva od spuštění rozhraní API
StatusCode Kód výsledku. Možné hodnoty jsou 200, 400, 401, 403, 500