レポート クエリの取得 API

レポート クエリの取得 API では、レポートで使用できるすべてのクエリが取得されます。 既定では、すべてのシステムおよびユーザー定義クエリが取得されます。

要求の構文

認証方法	要求 URI
GET	https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

要求ヘッダー

Header	型	説明
承認	string	必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token>
Content-Type	string	Application/JSON

パス パラメーター

なし

Query parameter (クエリ パラメーター)

パラメーター名	型	Required	説明
queryId	文字列	いいえ	引数に指定された ID を持つクエリのみの詳細を取得するフィルター
queryName	文字列	いいえ	引数に指定された名前を持つクエリのみの詳細を取得するフィルター
IncludeSystemQueries	ブール	いいえ	応答に定義済みのシステム クエリを含める
IncludeOnlySystemQueries	ブール	いいえ	応答にシステム クエリのみを含める

要求ペイロード

なし

要求用語集

なし

回答

応答ペイロードは、次のように構成されます。

応答コード: 200、400、401、403、404、500

応答ペイロードの例:

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

応答用語集

次の表に、応答の主な要素を定義します。

パラメーター	説明
QueryId	クエリの一意の UUID
名前	クエリの作成時にクエリに指定された名前
説明	クエリの作成時に指定された説明
クエリ	レポート クエリ文字列
「」と入力します	ユーザーが作成したクエリの場合は userDefined に設定し、定義済みのシステム クエリの場合はシステムに設定します
ユーザー	クエリを作成したユーザー ID
CreatedTime	クエリの作成時刻
TotalCount	Value 配列内のデータセットの数
メッセージ	API の実行からのステータス メッセージ
StatusCode	結果コード。 指定できる値は、200、400、401、403、500 です。