Atualizar API de relatório

Artigo
06/29/2024

Essa API ajuda a modificar um parâmetro de relatório.

Sintaxe da solicitação

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

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

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string",
 "CallbackMethod": "string"
}

Solicitar glossário

Esta tabela lista as principais definições dos elementos da resposta.

Parâmetro	Obrigatório	Descrição	Valores permitidos
ReportName	Sim	Nome a ser atribuído ao relatório	String
Descrição	Não	Descrição do relatório criado	String
StartTime	Sim	Carimbo de data/hora após o qual a geração de relatório será iniciada	String
RecurrenceInterval	Não	Frequência em horas em que o relatório deve ser gerado. O valor mínimo é 4	Inteiro
RecurrenceCount	Não	Número de relatórios a serem gerados. O padrão é indefinido.	Inteiro
Formatar	Não	Formato de arquivo do arquivo exportado. O padrão é CSV	CSV/TSV
CallbackURL	Não	URL de retorno de chamada https a ser chamada na geração de relatório	String
CallbackMethod	Não	Método http a ser usado para retorno de chamada	GET/POST

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 sendo atualizado
ReportName	Nome fornecido ao relatório na carga de solicitação
Descrição	Descrição fornecida ao relatório na carga de solicitação
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 na carga de solicitação
RecurrenceCount	Contagem de recorrências fornecido na carga de solicitação
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

Compartilhar via