レポート クエリの取得 API

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

要求の構文

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

要求ヘッダー

ヘッダー Type 説明
承認 string 必須。 フォーム内の Azure Active Directory (AAD) アクセストークンBearer <token>
Content-Type string Application/JSON

パス パラメーター

なし

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

パラメーター名 Type 必須 説明
queryId string いいえ 引数で指定された ID を持つクエリのみの詳細を取得するフィルター
queryName string いいえ 引数で指定された名前を持つクエリのみの詳細を取得するフィルター
IncludeSystemQueries boolean いいえ 定義済みのシステム クエリを応答に含めます
IncludeOnlySystemQueries boolean いいえ システム クエリのみを応答に含めます

要求ペイロード

なし

用語集

None

応答

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

応答コード: 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
名前 クエリの作成時にクエリに指定された名前
説明 クエリの作成時に指定された説明
クエリ レポート クエリ文字列
定義済みのシステムクエリに対してユーザーが作成したクエリおよびシステムの [ユーザー定義] に設定します。
User クエリを作成したユーザーの ID
CreatedTime クエリの作成時刻
TotalCount Value 配列内のデータセットの数
Message API の実行からのステータス メッセージ
StatusCode 結果コード。 200、400、401、403、500 の値になる可能性があります