レポートの更新 API

この API を使用すると、レポート パラメーターを変更できます。

要求の構文

認証方法	要求 URI
PUT	https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/{Report ID}

要求ヘッダー

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

パス パラメーター

パラメーター名	型	Required	説明
reportId	string	いいえ	変更中のレポートの ID

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

なし

要求ペイロード

{
  "ReportName": "string",
  "Description": "string",
  "StartTime": "string",
  "RecurrenceInterval": 0,
  "RecurrenceCount": 0,
  "Format": "string",
  "CallbackUrl": "string",
 "CallbackMethod": "string"
}

要求用語集

次の表では、応答内の要素の主な定義を示しています。

パラメーター	必須	説明	使用できる値
ReportName	はい	レポートに割り当てる名前	文字列
説明	なし	作成されたレポートの説明	文字列
Starttime	はい	レポートの生成が開始されるタイムスタンプ	文字列
RecurrenceInterval	なし	レポートが生成される頻度 (時間単位)。 最小値は 4 です	Integer
RecurrenceCount	なし	生成されるレポートの数。 既定値は無期限です。	Integer
Format	いいえ	エクスポートされるファイルのファイル形式。 既定値は CSV です	CSV/TSV
CallbackURL	なし	レポート生成時に呼び出される https コールバック URL	文字列
CallbackMethod	いいえ	コールバックに使用する HTTP メソッド	GET/POST

回答

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

応答コード: 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": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

応答用語集

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

パラメーター	説明
ReportId	更新中のレポートの汎用一意識別子 (UUID)
ReportName	要求ペイロード内のレポートに指定された名前
説明	要求ペイロード内のレポートに指定された説明
QueryId	レポートの作成時に渡されたクエリ ID
クエリ	このレポートに対して実行されるクエリ テキスト
ユーザー	レポートの作成に使用されるユーザー ID
CreatedTime	レポートが作成された時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ModifiedTime	レポートが最後に変更された時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ExecuteNow	レポートの作成時に設定された ExecuteNow フラグ
Starttime	レポートの実行が開始される時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ReportStatus	レポート実行の状態。 有効な値は、Paused、Active、および Inactive です。
RecurrenceInterval	要求ペイロードで指定された繰り返し間隔
RecurrenceCount	要求ペイロードで指定された繰り返し数
CallbackUrl	要求で指定されたコールバック URL
CallbackMethod	要求で指定されたコールバック メソッド
Format	レポート ファイルの形式
TotalCount	Value 配列内のデータセットの数
メッセージ	API の実行からのステータス メッセージ
StatusCode	結果コード。 指定できる値は、200、400、401、403、500 です。