Compartir a través de


Pausar la API de ejecuciones de informes para marketplace comercial

Esta API se usa para pausar la ejecución programada del informe.

Sintaxis de la solicitud

Método URI de la solicitud
PUT https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/pause/{ReportID}

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización string Necesario. Token de acceso de Microsoft Entra en el formulario Bearer <token>
Content-Type string Application/JSON

Parámetro de ruta de acceso

None

Parámetro de consulta

Nombre de parámetro Obligatorio Type Descripción
reportId string Id. del informe que se está modificando

Glosario

None

Respuesta

La carga de respuesta tiene la estructura siguiente en formato JSON:

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

{
  "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
}

Glosario

Parámetro Descripción
ReportId Identificador único universal (UUID) del informe que creó.
ReportName Nombre proporcionado en la carga de solicitud durante la creación del informe
Description Descripción proporcionada en la carga de solicitud durante la creación del informe
QueryId Identificador de consulta proporcionado en la carga de la solicitud durante la creación del informe
Query Texto de la consulta que se ejecutará para este informe
User Id. de usuario usado para crear el informe.
CreatedTime Hora UTC en que se creó el informe en el formato aaaa-MM-ddTHH:mm:ssZ.
ModifiedTime Hora UTC en que se modificó el informe en el formato aaaa-MM-ddTHH:mm:ssZ.
ExecuteNow Parámetro ExecuteNow proporcionado en la carga de solicitud durante la creación del informe
queryStartTime Hora de inicio de la consulta proporcionada en la carga de la solicitud durante la creación del informe. Esto solo es aplicable si ExecuteNow se establece en "True"
queryEndTime Hora de finalización de la consulta proporcionada en la carga de la solicitud durante la creación del informe. Esto solo es aplicable si ExecuteNow se establece en "True"
StartTime Hora de inicio proporcionada en la carga de la solicitud durante la creación del informe
ReportStatus Estado de la ejecución del informe. Los valores posibles son En pausa, Activo e Inactivo.
RecurrenceInterval Intervalo de periodicidad proporcionado en la carga de la solicitud durante la creación del informe
RecurrenceCount Recuento de periodicidad restante para el informe
CallbackUrl Dirección URL de devolución de llamada proporcionada en la carga de la solicitud durante la creación del informe
CallbackMethod Método de devolución de llamada proporcionado en la carga de la solicitud durante la creación del informe
Format Formato de los archivos de informe proporcionados en la carga de solicitud durante la creación del informe
EndTime Hora de finalización proporcionada en la carga de la solicitud durante la creación del informe. Esto solo es aplicable si ExecuteNow se establece en "True"
TotalRecurrenceCount RecurrenceCount proporcionado en la carga de solicitud durante la creación del informe
nextExecutionStartTime Marca de tiempo UTC cuando se inicie la próxima ejecución del informe
TotalCount Número de registros de la matriz Value.
StatusCode Código de resultado. Los valores posibles son 200, 400, 401, 403 y 500.
message Mensaje de estado de la ejecución de la API.