Retomar a API de execuções de relatórios para o mercado comercial
Essa API é usada para retomar a execução de um relatório pausado.
Sintaxe da solicitação
Método | URI da solicitação |
---|---|
PUT | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/resume/{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
Nenhum
Parâmetro de consulta
Nome do Parâmetro | Obrigatório | Type | Descrição |
---|---|---|---|
reportId |
Sim | string | ID do relatório que está sendo modificado |
Glossário
Nenhum
Response
A carga de solicitação é estruturada conforme a seguir no formato JSON:
Código de resposta: 200, 400, 401, 403, 404, 500
Carga 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 universal exclusivo) do relatório criado |
ReportName |
Nome fornecido na carga de 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 da consulta fornecida na carga da solicitação durante a criação do relatório |
Query |
Texto da consulta que será executada para este relatório |
User |
ID de usuário usada para criar o relatório |
CreatedTime |
Hora UTC em que o relatório foi criado neste formato: aaaa-MM-ddTHH:mm:ssZ |
ModifiedTime |
Hora UTC em que o relatório foi modificado pela última vez neste formato: aaaa-MM-ddTHH:mm:ssZ |
ExecuteNow |
Parâmetro ExecuteNow fornecido na carga de 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 é aplicável somente 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 é aplicável somente se ExecuteNow estiver definido como "True" |
StartTime |
Hora de início fornecida na carga de 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 de 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 de solicitação durante a criação do relatório |
CallbackMethod |
Método de retorno de chamada fornecido na carga de solicitação durante a criação do relatório |
Format |
Formato dos arquivos de relatório fornecidos na carga de solicitação durante a criação do relatório |
EndTime |
Hora de término fornecida na carga de solicitação durante a criação do relatório. Isso é aplicável somente 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 Value |
StatusCode |
Código de resultado. Os valores possíveis são 200, 400, 401, 403, 500 |
message |
Mensagem do status da execução da API |