Rapportquery's-API ophalen voor commerciële marketplace

De API rapportquery's ophalen haalt alle query's op die beschikbaar zijn voor gebruik in rapporten. Alle door de gebruiker gedefinieerde query's worden standaard door het systeem en de gebruiker opgevraagd.

Aanvraagsyntaxis

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

Aanvraagheader

Koptekst	Type	Beschrijving
Autorisatie	tekenreeks	Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>
Inhoudstype	tekenreeks	Application/JSON

Padparameter

Geen

Queryparameter

Parameternaam	Type	Vereist	Beschrijving
queryId	tekenreeks	Nee	Filter om alleen details van query's op te halen met de id die in het argument is opgegeven
queryName	tekenreeks	Nee	Filter om details van alleen query's op te halen met de naam die in het argument is opgegeven
IncludeSystemQueries	boolean	Nee	Neem vooraf gedefinieerde systeemquery's op in het antwoord. De standaardwaarde is Waar.
IncludeOnlySystemQueries	boolean	Nee	Neem alleen systeemquery's op in het antwoord. De standaardwaarde is Onwaar

Nettolading aanvragen

Geen

Woordenlijst

Geen

Respons

De nettolading van het antwoord is als volgt gestructureerd:

Antwoordcode: 200, 400, 401, 403, 404, 500

Nettolading van antwoord:

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

Woordenlijst

In deze tabel worden de belangrijkste definities van elementen in het antwoord beschreven.

Parameter	Beschrijving
QueryId	Unieke UUID van de query
Name	De naam die aan de query is gegeven op het moment dat de query is gemaakt
Description	Beschrijving gegeven tijdens het maken van de query
Query	Rapportquerytekenreeks
Type	Ingesteld op userDefined voor door de gebruiker gemaakte query's en system voor vooraf gedefinieerde systeemquery's
User	Gebruikers-id die de query heeft gemaakt
CreatedTime	Tijd van het maken van query's
TotalCount	Aantal gegevenssets in de waardematrix
StatusCode	Resultaatcode. De mogelijke waarden zijn 200, 400, 401, 403, 500