Obtenir l’API de rapport pour la Place de marché Microsoft

Cette API obtient tous les rapports qui ont été planifiés.

Syntaxe de la requête

Méthode	URI de requête
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

En-tête de requête

Header	Type	Description
Authorization	ficelle	Obligatoire. Jeton d’accès Microsoft Entra dans le formulaire Bearer <token>
Type de contenu	ficelle	Application/JSON

Paramètre de chemin d’accès

Aucun

Paramètre de requête

Nom du paramètre	Obligatoire	Type	Description
reportId	Non	ficelle	Filtrez pour obtenir les détails des rapports uniquement avec l’argument reportId donné. Plusieurs reportId peuvent être spécifiés en les séparant par des points-virgules (;)
reportName	Non	ficelle	Filtrer pour obtenir les détails des rapports uniquement avec l’argument reportName donné
queryId	Non	boolean	Inclure des requêtes système prédéfinies dans la réponse

Glossaire

Aucun

Réponse

La charge utile de réponse est structurée au format JSON comme suit :

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

Charge utile de réponse :

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

Glossaire

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

Paramètre	Descriptif
ReportId	Identificateur unique universel (UUID) du rapport que vous avez créé
ReportName	Nom fourni dans la charge utile de la demande lors de la création du rapport
Description	Description fournie dans la charge utile de la demande lors de la création du rapport
QueryId	ID de requête fourni dans la charge utile de la requête lors de la création du rapport
Query	Texte de requête qui sera exécuté pour ce rapport
User	ID utilisateur utilisé pour créer le rapport
CreatedTime	Heure UTC que le rapport a été créé dans ce format : aaaa-MM-ddTHH :mm :ssZ
ModifiedTime	Heure UTC que le rapport a été modifié pour la dernière fois dans ce format : aaaa-MM-ddTHH :mm :ssZ
ExecuteNow	Paramètre ExecuteNow fourni dans la charge utile de la demande lors de la création du rapport
queryStartTime	Heure de début de la requête fournie dans la charge utile de la requête lors de la création du rapport. Cela s’applique uniquement s’il ExecuteNow est défini sur « True »
queryEndTime	Heure de fin de requête fournie dans la charge utile de la requête lors de la création du rapport. Cela s’applique uniquement s’il ExecuteNow est défini sur « True »
StartTime	Heure de début fournie dans la charge utile de la demande lors de la création du rapport
ReportStatus	État de l’exécution du rapport. Les valeurs possibles sont suspendues, actives et inactives.
RecurrenceInterval	Intervalle de périodicité fourni dans la charge utile de la requête lors de la création du rapport
RecurrenceCount	Nombre de périodicités restantes pour le rapport
CallbackUrl	URL de rappel fournie dans la charge utile de la demande lors de la création du rapport
CallbackMethod	Méthode de rappel fournie dans la charge utile de la demande lors de la création du rapport
Format	Format des fichiers de rapport fournis dans la charge utile de la demande lors de la création du rapport
EndTime	Heure de fin fournie dans la charge utile de la demande lors de la création du rapport. Cela s’applique uniquement s’il ExecuteNow est défini sur « True »
TotalRecurrenceCount	RecurrenceCount fourni dans la charge utile de la demande lors de la création du rapport
nextExecutionStartTime	Horodatage UTC au démarrage de l’exécution du rapport suivant
TotalCount	Nombre d’enregistrements dans le tableau Valeur
StatusCode	Code de résultat. Les valeurs possibles sont 200, 400, 401, 403, 500
message	Message d’état de l’exécution de l’API