Obtenir l’API requêtes de rapport pour la Place de marché commerciale

L’API Obtenir des requêtes de rapport obtient toutes les requêtes pouvant être utilisées dans les rapports. Elle obtient toutes les requêtes système et définies par l’utilisateur par défaut.

Syntaxe de la requête

Méthode	URI de demande
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

En-tête de requête

En-tête	Type	Description
Autorisation	string	Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>
Content-Type	string	Application/JSON

Paramètre de chemin

Aucune

Paramètre de requête

Nom du paramètre	Type	Requis	Description
queryId	string	Non	Filtre permettant d’obtenir les détails des seules requêtes avec l’ID fourni dans l’argument
queryName	string	Non	Filtre permettant d’obtenir les détails des seules requête avec le nom founi dans l’argument
IncludeSystemQueries	booléen	Non	Incluez des requêtes système prédéfinies dans la réponse. La valeur par défaut est True.
IncludeOnlySystemQueries	booléen	Non	Incluez uniquement les requêtes système dans la réponse. La valeur par défaut est False

Charge utile de la demande

Aucune

Glossaire

Aucune

Response

La charge utile de la réponse est structurée comme suit :

Code de réponse : 200, 400, 401, 403, 404, 500

Charge utile de réponse :

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Glossaire

Ce tableau répertorie les définitions clés des éléments dans la réponse.

Paramètre	Description
QueryId	UUID unique de la requête
Name	Nom donné à la requête au moment de sa création
Description	Description donnée lors de la création de la requête
Query	Chaîne de requête de rapport
Type	Définir sur userDefined pour les requêtes créées par l’utilisateur et system pour les requêtes système prédéfinies
User	ID de l’utilisateur qui a créé la requête
CreatedTime	Heure de création de la requête
TotalCount	Nombre de jeux de données dans le tableau de valeur
StatusCode	Code de résultat Les valeurs possibles sont 200, 400, 401, 403, 500