Sdílet prostřednictvím


Odstranění rozhraní API sestavy pro komerční marketplace

Při provedení toto rozhraní API odstraní všechny záznamy o sestavách a o vykonávání sestav.

Syntaxe požadavku

Metoda Požadavek URI
VYMAZAT 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 cesta

Žádný

Parametr dotazu

Název parametru Povinný řetězec Popis
reportId Ano řetězec ID sestavy, která se upravuje

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 datové části požadavku během vytváření sestavy
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ý se spustí pro tuto sestavu
User ID uživatele, které bylo použito 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ém obsahu požadavku během vytváření zprávy
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í zprávy Možné hodnoty jsou Pozastaveno, Aktivnía Neaktivní.
RecurrenceInterval Interval opakování uvedený v datové části žádosti během vytváření zprávy
RecurrenceCount Zbývající počet opakování pro sestavu
CallbackUrl Adresa URL poskytnutá pro zpětné volání 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 poskytnutých v payloadu 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 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