Supprimer l’API de rapport pour la Place de marché commerciale
Lors de son exécution, cette API supprime tous les enregistrements de rapport et d’exécution de rapport.
Syntaxe de la requête
Méthode | URI de demande |
---|---|
Suppression | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID} |
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> |
Type de contenu | string | Application/JSON |
Paramètre de chemin
Aucune
Paramètre de requête
Nom du paramètre | Requis | string | Description |
---|---|---|---|
reportId |
Oui | string | ID du rapport en cours de modification |
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": [
{
"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
Paramètre | Description |
---|---|
ReportId |
Identificateur unique universel (UUID) du rapport 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 d’utilisateur utilisé pour créer le rapport |
CreatedTime |
Heure UTC de création du rapport au format suivant : aaaa-MM-jjTHH:mm:ssZ |
ModifiedTime |
Heure UTC de dernière modification du rapport au format suivant : aaaa-MM-jjTHH: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 d’exécution du rapport. Les valeurs possibles sont Paused, Active et Inactive. |
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 d’’exécution de l’API |