Compartilhar via

Pausar API de execuções de relatório

  • Artigo

Em execução, essa API pausa a execução agendada de relatórios.

Sintaxe da solicitação

Método URI da solicitação
PUT https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/pause/{ReportID}

Cabeçalho da solicitação

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

Parâmetro de caminho

Nome do Parâmetro Tipo Obrigatória Descrição
reportId string Não ID do relatório que está sendo modificado

Parâmetro de consulta

Nenhum

Payload da solicitação

Nenhum

Solicitar glossário

Nenhum

Resposta

A carga de solicitação é estrutura conforme a seguir:

Código de resposta: 200, 400, 401, 403, 404, 500

Exemplo de conteúdo da resposta:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "ExecuteNow": true,
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "CallbackMethod": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

Glossário de respostas

Esta tabela define os principais elementos na resposta:

Parâmetro Descrição
ReportId UUID (Identificador universal exclusivo) do relatório pausado
ReportName Nome dado ao relatório durante a criação
Descrição Descrição fornecida durante a criação do relatório
QueryId ID de consulta passada no momento da criação do relatório
Consulta Texto da consulta que será executada para este relatório
Usuário ID de usuário usada para criar o relatório
CreatedTime Hora de criação do relatório. O formato de hora é aaaa-MM-ddTHH:mm:ssZ
ModifiedTime Hora em que o relatório foi modificado pela última vez. O formato de hora é aaaa-MM-ddTHH:mm:ssZ
ExecuteNow Sinalizador ExecuteNow definido no momento em que o relatório foi criado
StartTime Hora em que a execução do relatório será iniciada. O formato de hora é aaaa-MM-ddTHH:mm:ssZ
ReportStatus Status da execução do relatório. Os valores possíveis são Pausado, Ativo e Inativo.
RecurrenceInterval Intervalo de recorrência fornecido durante a criação do relatório
RecurrenceCount Contagem de recorrência fornecido durante a criação do relatório
CallbackUrl URL de retorno de chamada fornecida na solicitação
CallbackMethod Método de retorno de chamada fornecido na solicitação
Formatar Formato dos arquivos do relatório
TotalCount Número de conjuntos de itens na Matriz de valores
Mensagem Mensagem do status da execução da API
StatusCode Código de resultado. Os valores possíveis são 200, 400, 401, 403, 500