Compartilhar via


Pausar a API de execuções de relatório

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

Sintaxe de solicitação

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

Cabeçalho de solicitação

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

Parâmetro de caminho

Nome do parâmetro Tipo Necessário Descrição
reportId corda Não ID do relatório que está sendo modificado

Parâmetro de consulta

Nenhum

Conteúdo da solicitação

Nenhum

Glossário de solicitação

Nenhum

Resposta

O conteúdo da resposta é estruturado da seguinte maneira:

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

Exemplo de conteúdo de 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 resposta

Esta tabela define os principais elementos na resposta:

Parâmetro Descrição
ReportId UUID (identificador universal exclusivo) do relatório em pausa
ReportName Nome fornecido ao relatório durante a criação
Descrição Descrição fornecida durante a criação do relatório
QueryId ID da consulta passada no momento em que o relatório foi criado
Consulta Texto de consulta que será executado para este relatório
Utilizador ID do usuário usada para criar o relatório
CreatedTime Hora em que o relatório foi criado. O formato de hora é yyyy-MM-ddTHH:mm:ssZ
ModifiedTime Hora em que o relatório foi modificado pela última vez. O formato de hora é yyyy-MM-ddTHH:mm:ssZ
ExecuteNow Conjunto de sinalizadores ExecuteNow 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 é yyyy-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 fornecida 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
Formato Formato dos arquivos de relatório
TotalCount Número de conjuntos de dados na matriz Value
Mensagem Mensagem de status da execução da API
StatusCode Código de resultado. Os valores possíveis são 200, 400, 401, 403, 500