Excluir API de relatório para mercado comercial
Na execução, essa API exclui todos os registros de execução de relatório e relatório.
Sintaxe da solicitação
Método | URI do pedido |
---|---|
DELETE | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID} |
Cabeçalho da solicitação
Cabeçalho | Tipo | Description |
---|---|---|
Autorização | string | Obrigatório. O token de acesso do Microsoft Entra no formato Bearer <token> |
Tipo de Conteúdo | string | Application/JSON |
Parâmetro Path
Nenhuma
Parâmetro de consulta
Nome do parâmetro | Necessário | string | Description |
---|---|---|---|
reportId |
Sim | string | ID do relatório que está sendo modificado |
Glossário
Nenhuma
Response
A carga útil de resposta está estruturada da seguinte forma:
Código de resposta: 200, 400, 401, 403, 404, 500
Carga útil de resposta:
{
"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
}
Glossário
Parâmetro | Description |
---|---|
ReportId |
UUID (identificador universalmente exclusivo) do relatório criado |
ReportName |
Nome fornecido na carga útil da solicitação durante a criação do relatório |
Description |
Descrição fornecida na carga útil da solicitação durante a criação do relatório |
QueryId |
ID de consulta fornecida na carga útil da solicitação durante a criação do relatório |
Query |
Texto de consulta que será executado para este relatório |
User |
ID de usuário usado para criar o relatório |
CreatedTime |
UTC Hora em que o relatório foi criado neste formato: aaaa-MM-ddTHH:mm:ssZ |
ModifiedTime |
Hora UTC O relatório foi modificado pela última vez neste formato: aaaa-MM-ddTHH:mm:ssZ |
ExecuteNow |
Parâmetro ExecuteNow fornecido na carga útil da solicitação durante a criação do relatório |
queryStartTime |
Hora de início da consulta fornecida na carga útil da solicitação durante a criação do relatório. Isso só é aplicável se ExecuteNow estiver definido como "True" |
queryEndTime |
Hora de término da consulta fornecida na carga útil da solicitação durante a criação do relatório. Isso só é aplicável se ExecuteNow estiver definido como "True" |
StartTime |
Hora de início fornecida na carga útil da solicitação durante a criação do relatório |
ReportStatus |
Status da execução do relatório. Os valores possíveis são Paused, Ative e Inative. |
RecurrenceInterval |
Intervalo de recorrência fornecido na carga útil da solicitação durante a criação do relatório |
RecurrenceCount |
Contagem de recorrência restante para o relatório |
CallbackUrl |
URL de retorno de chamada fornecida na carga útil da solicitação durante a criação do relatório |
CallbackMethod |
Método de retorno de chamada fornecido na carga útil da solicitação durante a criação do relatório |
Format |
Formato dos arquivos de relatório fornecidos na carga útil da solicitação durante a criação do relatório |
EndTime |
Hora de término fornecida na carga útil da solicitação durante a criação do relatório. Isso só é aplicável se ExecuteNow estiver definido como "True" |
TotalRecurrenceCount |
RecurrenceCount fornecido na carga útil da solicitação durante a criação do relatório |
nextExecutionStartTime |
Carimbo de data/hora UTC quando a próxima execução do relatório será iniciada |
TotalCount |
Número de registros na matriz Valor |
StatusCode |
Código do resultado. Os valores possíveis são 200, 400, 401, 403, 500 |
message |
Mensagem de status da execução da API |