Rozhraní API pro aktualizaci sestavy pro Microsoft Marketplace

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

syntaxe požadavku

Metoda Požadavek URI
DÁT https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

hlavičky požadavku

Záhlaví Typ Popis
Oprávnění řetězec Povinné. Přístupový token Microsoft Entra ve formuláři Bearer <token>
Typ obsahu řetězec Application/JSON

parametr cesty

Žádný

Parametr dotazu

Název parametru Povinný Typ Popis
reportId Ano řetězec ID upravované sestavy

datová část požadavku

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

glosář

Tato tabulka obsahuje seznam klíčových definic prvků v datové části požadavku.

Parametr Povinný Popis Povolené hodnoty
ReportName Ano Název pro sestavu řetězec
Description Ne Popis vytvořené sestavy řetězec
StartTime Ano Časové razítko, od kterého začne generování sestavy řetězec
RecurrenceInterval Ne Frekvence, se kterou by měla být sestava generována, v hodinách. Minimální hodnota je 4 integer
RecurrenceCount Ne Počet vygenerovaných sestav Výchozí hodnota je neomezená. integer
Format Ano Formát souboru exportovaného souboru Výchozí hodnota je CSV. CSV/TSV
CallbackUrl Ano Adresa URL pro https zpětné volání, která se má použít při generování sestavy. řetězec
CallbackMethod Ne Metoda Get/Post, kterou lze nakonfigurovat s adresou URL zpětného volání GET/POST
endTime Ne Časové razítko UTC, do kdy bude generování sestavy ukončeno. Formát by měl být rrrr-MM-ddTHH:mm:ssZ. řetězec

glosář

Žádný

odpovědi

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

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

Datová část odpovědi:

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

glosář

Parametr Popis
ReportId Univerzální jedinečný identifikátor (UUID) sestavy, kterou jste vytvořili
ReportName Název zadaný v nákladu požadavku během vytváření zprávy
Description Popis zadaný v datové části požadavku během vytváření sestavy
QueryId ID dotazu zadané v datové části požadavku během vytváření sestavy
Query Text dotazu, který bude proveden pro tuto sestavu
User ID uživatele použitý pro vytvoření zprávy
CreatedTime UTC Čas vytvoření sestavy v tomto formátu: rrrr-MM-ddTHH:mm:ssZ
ModifiedTime UTC Čas poslední změny sestavy v tomto formátu: rrrr-MM-ddTHH:mm:ssZ
ExecuteNow Parametr ExecuteNow zadaný v datové části požadavku během vytváření sestavy
queryStartTime Čas spuštění dotazu zadaný v datové části požadavku během vytváření sestavy To platí jenom v případě, že je ExecuteNow nastavená na Hodnotu True.
queryEndTime Čas ukončení dotazu zadaný v datové části požadavku při vytváření reportu. To platí jenom v případě, že je ExecuteNow nastavená na Hodnotu True.
StartTime Počáteční čas zadaný v datové části žádosti během vytváření sestavy
ReportStatus Stav zpracování sestavy Možné hodnoty jsou Pozastaveno, Aktivnía Neaktivní.
RecurrenceInterval Interval opakování uvedený v požadavku v průběhu vytváření zprávy
RecurrenceCount Počet zbývajících opakovacích cyklů pro sestavu
CallbackUrl Adresa URL zpětného volání zadaná v datové části požadavku během vytváření sestavy
CallbackMethod Metoda zpětného volání zadaná v datové části požadavku během vytváření sestavy
Format Formát souborů sestavy zadaných v datové části požadavku během vytváření sestavy
EndTime Koncový čas poskytnutý v datové části požadavku během vytváření sestavy To platí jenom v případě, že je ExecuteNow nastavená na Hodnotu True.
TotalRecurrenceCount RecurrenceCount zadané v datové části požadavku během vytvoření reportu
nextExecutionStartTime Časové razítko UTC, kdy se spustí další spuštění sestavy
TotalCount Počet záznamů v poli Hodnota
StatusCode Kód výsledku Možné hodnoty jsou 200, 400, 401, 403, 500
message Stavová zpráva ze spuštění rozhraní API
  • Last updated on