コマーシャル マーケットプレースのレポート実行 API を再開する
この API は、一時停止されたレポートの実行を再開するために使用されます。
要求構文
認証方法 | 要求 URI |
---|---|
PUT | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/resume/{reportId} |
要求ヘッダー
Header | 型 | 説明 |
---|---|---|
承認 | string | 必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token> |
コンテンツタイプ | string | Application/JSON |
パス パラメーター
なし
クエリ パラメーター
パラメーター名 | 必須 | タイプ | 説明 |
---|---|---|---|
reportId |
イエス | string | 変更されるレポートの ID |
用語集
なし
回答
応答ペイロードは、JSON 形式で次のように構成されます。
応答コード: 200、400、401、403、404、500
応答ペイロード:
{
"Value": [
{
"ReportId": "string",
"ReportName": "string",
"Description": "string",
"QueryId": "string",
"Query": "string",
"User": "string",
"CreatedTime": "string",
"ModifiedTime": "string",
"StartTime": "string",
"ReportStatus": "string",
"RecurrenceInterval": 0,
"RecurrenceCount": 0,
"CallbackUrl": "string",
"Format": "string"
}
],
"TotalCount": 0,
"Message": "string",
"StatusCode": 0
}
用語集
パラメーター | 説明 |
---|---|
ReportId |
作成したレポートの汎用一意識別子 (UUID) |
ReportName |
レポートの作成時に要求ペイロードに指定された名前 |
Description |
レポートの作成時に要求ペイロードに指定された説明 |
QueryId |
レポートの作成時に要求ペイロードに指定されたクエリ ID |
Query |
このレポートに対して実行されるクエリ テキスト |
User |
レポートの作成に使用するユーザー ID |
CreatedTime |
レポートが作成された UTC 時刻で、形式は yyyy-MM-ddTHH:mm:ssZ |
ModifiedTime |
レポートが最終更新された UTC 時刻で、形式は yyyy-MM-ddTHH:mm:ssZ |
ExecuteNow |
レポートの作成時に要求ペイロードに指定された ExecuteNow パラメーター |
queryStartTime |
レポートの作成時に要求ペイロードに指定されたクエリの開始時刻。 これは、"True" に設定されている場合 ExecuteNow にのみ適用されます。 |
queryEndTime |
レポートの作成時に要求ペイロードに指定されたクエリの終了時刻。 これは、"True" に設定されている場合 ExecuteNow にのみ適用されます。 |
StartTime |
レポートの作成中に要求ペイロードに指定された開始時刻 |
ReportStatus |
レポート実行の状態。 有効な値は、Paused、Active、および Inactive です。 |
RecurrenceInterval |
レポートの作成中に要求ペイロードに指定された繰り返し間隔 |
RecurrenceCount |
レポートの残りの繰り返し数 |
CallbackUrl |
レポートの作成時に要求ペイロードに指定されたコールバック URL |
CallbackMethod |
レポートの作成時に要求ペイロードで提供されるコールバック メソッド |
Format |
レポートの作成時に要求ペイロードに指定されたレポート ファイルの形式 |
EndTime |
レポートの作成中に要求ペイロードに指定された終了時刻。 これは、"True" に設定されている場合 ExecuteNow にのみ適用されます。 |
TotalRecurrenceCount |
RecurrenceCount レポートの作成時に要求ペイロードに指定された |
nextExecutionStartTime |
次のレポートの実行が開始される UTC タイムスタンプ |
TotalCount |
Value 配列内のレコードの数 |
StatusCode |
結果コード。 200、400、401、403、500 の値になる可能性があります |
message |
API の実行からのステータス メッセージ |