Ottenere l'API per le query di report per il marketplace commerciale

L'API Get report queries ottiene tutte le query disponibili per l'uso nei report. Ottiene tutte le query di sistema e definite dall'utente per impostazione predefinita.

Sintassi della richiesta

Metodo	URI della richiesta
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Intestazione della richiesta

Intestazione	Type	Descrizione
Autorizzazione	stringa	Obbligatorio. Token di accesso Di Microsoft Entra nel modulo Bearer <token>
Content-Type	string	Application/JSON

Parametro Path

None

Parametro di query

Nome parametro	Tipo	Obbligatorio	Descrizione
queryId	stringa	No	Filtrare per ottenere i dettagli solo delle query con l'ID specificato nell'argomento
queryName	string	No	Filtrare per ottenere i dettagli solo delle query con il nome specificato nell'argomento
IncludeSystemQueries	boolean	No	Includere query di sistema predefinite nella risposta. Il valore predefinito è True.
IncludeOnlySystemQueries	boolean	No	Includere solo le query di sistema nella risposta. Il valore predefinito è False

Payload della richiesta

None

Glossario

None

Response

Il payload della risposta è strutturato come segue:

Codice risposta: 200, 400, 401, 403, 404, 500

Payload della risposta:

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

Glossario

Questa tabella descrive le definizioni chiave degli elementi nella risposta.

Parametro	Descrizione
QueryId	UUID univoco della query
Name	Nome assegnato alla query al momento della creazione della query
Description	Descrizione specificata durante la creazione della query
Query	Stringa di query del report
Type	Impostare su userDefined per le query create dall'utente e system per le query di sistema predefinite
User	ID utente che ha creato la query
CreatedTime	Ora di creazione della query
TotalCount	Numero di set di dati nella matrice Valore
StatusCode	Codice risultato. I valori possibili sono 200, 400, 401, 403, 500