Obtención de la API de informes para marketplace comercial

Esta API obtiene todos los informes que se han programado.

Sintaxis de la solicitud

Método	URI de solicitud
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

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	Tipo	Descripción
reportId	No	string	Filtre para obtener detalles de solo los informes con el reportId especificado en este argumento. Se pueden especificar varios reportId separando con punto y coma (;)
reportName	No	string	Filtrar para obtener los detalles de solo los informes con el elemento reportName especificado en este argumento
queryId	No	boolean	Incluir consultas predefinidas por el sistema en la respuesta

Glosario

None

Respuesta

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

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

En esta tabla se indican las definiciones clave de los elementos de la respuesta.

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.