Partilhar via


Pausar a API de execução de relatórios para o mercado comercial

Essa API é usada para pausar a execução agendada do relatório.

Sintaxe de solicitação

Método Solicitar URI
COLOCAR https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/pause/{ReportID}

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Necessário. O token de acesso do Microsoft Entra no formato Bearer <token>
Tipo de conteúdo string Application/JSON

Parâmetro Path

Nenhum

Parâmetro de consulta

Nome do parâmetro Necessário Tipo Descrição
reportId Sim string ID do relatório que está a ser modificado

Glossário

Nenhum

Resposta

A carga útil de resposta é estruturada da seguinte forma no formato JSON:

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 Descrição
ReportId UUID (identificador universalmente exclusivo) do relatório criado
ReportName Nome fornecido no corpo 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 no conteúdo 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 no conteúdo do pedido 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 "Verdadeiro"
queryEndTime Hora de término da consulta fornecida no payload do pedido ao criar o relatório. Isso só é aplicável se ExecuteNow estiver definido como "Verdadeiro"
StartTime Hora de início fornecida no conteúdo da solicitação durante a criação do relatório
ReportStatus Status da execução do relatório. Os valores possíveis são Pausado, Ativoe Inativo.
RecurrenceInterval Intervalo de recorrência fornecido na carga útil da solicitação durante a criação do relatório
RecurrenceCount Contagem de repetições restantes para o relatório
CallbackUrl URL de callback fornecida nos dados da solicitação durante a criação do relatório
CallbackMethod Método de callback fornecido no conteúdo 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 "Verdadeiro"
TotalRecurrenceCount RecurrenceCount fornecido nos dados 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