Compartir a través de

Obtención de la API de consultas de informes para marketplace comercial

  • Artículo

La API de obtención de consultas de informe obtiene todas las consultas que están disponibles para su uso en informes. Obtiene todas las consultas del sistema y las definidas por el usuario de forma predeterminada.

Sintaxis de la solicitud

Método URI de solicitud
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

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 del parámetro Tipo Necesario Descripción
queryId string No Filtrar para obtener los detalles de solo las consultas con el id. dado en el argumento
queryName string No Filtrar para obtener los detalles de solo las consultas con el nombre dado en el argumento
IncludeSystemQueries boolean No Incluya consultas del sistema predefinidas en la respuesta. El valor predeterminado es Verdadero.
IncludeOnlySystemQueries boolean No Incluya solo las consultas del sistema en la respuesta. El valor predeterminado es False

Carga de solicitud

None

Glosario

None

Respuesta

La carga de respuesta tiene la estructura siguiente:

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

Carga de respuesta:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Glosario

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

Parámetro Descripción
QueryId UUID único de la consulta.
Name Nombre asignado a la consulta en el momento de la creación de la consulta.
Description Descripción proporcionada durante la creación de la consulta.
Query Cadena de consulta del informe.
Type Se establece en userDefined para las consultas creadas por el usuario y en system para las consultas predefinidas por el sistema.
User Id. de usuario que creó la consulta.
CreatedTime Hora de creación de la consulta.
TotalCount Número de conjuntos de datos en la matriz de valores.
StatusCode Código de resultado. Los valores posibles son 200, 400, 401, 403 y 500.