レポートの取得 API

この API では、スケジュールされているすべてのレポートを取得します。

要求の構文

Method 要求 URI
GET https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

要求ヘッダー

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

パス パラメーター

なし

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

パラメーター名 Type 必須 説明
reportId string No フィルターを適用して、この引数で指定された reportId を持つレポートの詳細のみを取得します
reportName string No フィルターを適用して、この引数で指定された reportName を持つレポートの詳細のみを取得します
queryId string No フィルターを適用して、この引数で指定された queryId を持つレポートの詳細のみを取得します

要求ペイロード

なし

用語集

None

応答

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

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

応答ペイロードの例:

{ 
  "Value": [ 
    { 
      "ReportId": "string", 
      "ReportName": "string", 
      "Description": "string", 
      "QueryId": "string", 
      "Query": "string", 
      "User": "string", 
      "CreatedTime": "string", 
      "ModifiedTime": "string", 
      "executeNow": true, 
      "StartTime": "string", 
      "ReportStatus": "string", 
      "RecurrenceInterval": 0, 
      " RecurrenceCount": 0, 
      "CallbackUrl": "string",
      "CallbackMethod": null,
      "Format": "string" 
    } 
  ], 
  "TotalCount": 0, 
  "Message": "string", 
  "StatusCode": 0 
}

用語集

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

パラメーター 説明
ReportId 作成されたレポートの一意の UUID
ReportName 要求ペイロードでレポートに指定された名前
説明 レポートの作成時に指定された説明
QueryId レポートの作成時に渡されたクエリ ID
クエリ このレポートに対して実行されるクエリ テキスト
User レポートの作成に使用するユーザー ID
CreatedTime レポートが作成された時刻。 時刻の形式は yyyy-MM-ddTHH:mm:ssZ です
ModifiedTime レポートが最後に変更された時刻。 時刻の形式は yyyy-MM-ddTHH:mm:ssZ です
executeNow レポートの作成時に設定された ExecuteNow フラグ
StartTime 実行が開始される時刻。 時刻の形式は yyyy-MM-ddTHH:mm:ssZ です
ReportStatus レポート実行のステータス。 有効な値は、一時停止、アクティブ、および非アクティブです。
RecurrenceInterval レポートの作成中に指定された繰り返し間隔
RecurrenceCount レポートの作成中に指定された繰り返し回数
CallbackUrl 要求で指定されたコールバック URL
CallbackMethod 要求で提供されるコールバック メソッド
フォーマット レポート ファイルの形式
TotalCount Value 配列内のデータセットの数
Message API の実行からのステータス メッセージ
StatusCode 結果コード。 200、400、401、403、500 の値になる可能性があります