Získání rozhraní API pro dotazy na sestavy

Rozhraní API Získat dotazy sestavy získá všechny dotazy, které jsou k dispozici pro použití v sestavách. Ve výchozím nastavení získá všechny systémové a uživatelsky definované dotazy.

Syntaxe požadavku

Metoda Identifikátor URI žádosti
GET https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Hlavička požadavku

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

Parametr cesty

Žádné

Parametr dotazu

Název parametru Typ Vyžadováno Popis
ID dotazu řetězec No Filtrováním získáte podrobnosti pouze o dotazech s ID daným v argumentu .
queryName (název dotazu) řetězec No Filtrováním získáte podrobnosti pouze o dotazech s názvem daným v argumentu .
IncludeSystemQueries boolean No Zahrnutí předdefinovaných systémových dotazů do odpovědi
IncludeOnlySystemQueries boolean No Zahrnutí pouze systémových dotazů do odpovědi

Žádost o datovou část

Žádné

Glosář

Žádné

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": [ 
    { 
      "QueryId": "string", 
      "Name": "string", 
      "Description": "string", 
      "Query": "string", 
      "Type": "string", 
      "User": "string", 
      "CreatedTime": "string", 
    } 
  ], 
  "TotalCount": 0, 
  "Message": "string", 
  "StatusCode": 0, 
} 

Glosář

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

Parametr Popis
ID dotazu Jedinečné UUID dotazu
Name Název předaný dotazu při vytváření dotazu
Description Popis při vytváření dotazu
Dotaz Řetězec dotazu sestavy
Typ Nastavte na userDefined pro dotazy vytvořené uživatelem a systém pro předdefinované systémové dotazy.
Uživatel ID uživatele, který dotaz vytvořil
CreatedTime Čas vytvoření dotazu
Celkový počet Počet datových sad v poli Hodnota
Zpráva Stavová zpráva z spuštění rozhraní API
Statuscode Kód výsledku. Možné hodnoty jsou 200, 400, 401, 403, 500.