Pozastavení rozhraní API pro spouštění sestav pro komerční marketplace

Toto rozhraní API slouží k pozastavení plánovaného spuštění sestavy.

syntaxe požadavku

Metoda	Identifikátor URI požadavku
Umístit	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/pause/{ReportID}

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	Požadovaný	Typ	Popis
reportId	Ano	řetězec	ID upravované sestavy

glosář

Žádný

odpověď

Datová část odpovědi je strukturovaná následujícím způsobem ve formátu JSON:

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	Jedinečný univerzální identifikátor (UUID) zprávy, kterou jste vytvořili
ReportName	Název uvedený v datové části žádosti během tvorby sestavy
Description	Popis zadaný v datové části požadavku během vytváření sestavy
QueryId	Identifikátor dotazu zadaný v datové části žádosti během vytváření sestavy
Query	Text dotazu, který se spustí pro tuto sestavu
User	ID uživatele použité k vytvoření sestavy
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	Koncový čas 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.
StartTime	Počáteční čas zadaný v datové části žádosti během vytváření sestavy
ReportStatus	Stav provádění sestavy Možné hodnoty jsou Pozastaveno, Aktivnía Neaktivní.
RecurrenceInterval	Interval opakování zadaný v datové části požadavku během vytváření sestavy
RecurrenceCount	Zbývající počet opakování pro výkaz
CallbackUrl	Adresa URL zpětného volání zadaná v datové části požadavku během vytváření reportu
CallbackMethod	Metoda zpětného volání uvedená v obsahu požadavku během vytváření zprávy
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 žádosti během vytváření sestavy
nextExecutionStartTime	Časové razítko UTC, kdy začne 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