更新商業市集的報告 API
此 API 可協助您修改報表參數。
要求語法
| 方法 | 要求 URI |
|---|---|
| 放 | https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID} |
請求標頭
| 頁眉 | 類型 | 描述 |
|---|---|---|
| 授權 | 字串 | 必填。 Microsoft Entra 以 Bearer <token> 格式的存取令牌 |
| 內容類型 | 字串 | Application/JSON |
Path 參數
沒有
查詢參數
| 參數名稱 | 必填 | 類型 | 描述 |
|---|---|---|---|
reportId |
是的 | 字串 | 正在修改之報表的標識碼 |
要求承載
{
"ReportName": "string",
"Description": "string",
"StartTime": "string",
"RecurrenceInterval": 0,
"RecurrenceCount": 0,
"Format": "string",
"CallbackUrl": "string"
}
詞彙
下表列出請求負載中元素的關鍵定義。
| 參數 | 必填 | 描述 | 允許的值 |
|---|---|---|---|
ReportName |
是的 | 要指定給報表的名稱 | 字串 |
Description |
不 | 已建立報表的描述 | 字串 |
StartTime |
是的 | 時間戳之後，報表產生將會開始 | 字串 |
RecurrenceInterval |
不 | 報告應該生成的頻率以小時為單位。 最小值為 4 | 整數 |
RecurrenceCount |
不 | 要產生的報表數目。 預設值為無限期 | 整數 |
Format |
是的 | 匯出檔案的檔案格式。 預設值為 CSV。 | CSV/TSV |
CallbackUrl |
是的 | 在產生報表時要呼叫的 HTTPS 回呼 URL | 字串 |
CallbackMethod |
不 | 取得/張貼方法，可使用回呼 URL 進行設定 | GET/POST |
endTime |
不 | 報表產生即將結束的UTC時間戳。 格式應該是 yyyy-MM-ddTHH：mm：ssZ | 字串 |
詞彙
沒有
回應
響應承載的結構如下：
回應碼：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 |
在報表建立期間的請求負載中提供的查詢標識碼 |
Query |
將針對此報表執行的查詢文字 |
User |
用來建立報表的使用者標識碼 |
CreatedTime |
UTC 以下列格式建立報表的時間：yyyy-MM-ddTHH：mm：ssZ |
ModifiedTime |
UTC 上次以此格式修改報表的時間：yyyy-MM-ddTHH:mm:ssZ |
ExecuteNow |
報表建立期間在要求承載中提供的 ExecuteNow 參數 |
queryStartTime |
報表建立時，在請求內容中提供的查詢開始時間。 只有當 ExecuteNow 設為 「True」 時才適用 |
queryEndTime |
在建立報表時，請求數據中提供的查詢結束時間。 只有當 ExecuteNow 設為 「True」 時才適用 |
StartTime |
在報表建立期間要求載入中提供的開始時間 |
ReportStatus |
報表執行的狀態。 可能的值為 Paused、Active和 Inactive。 |
RecurrenceInterval |
在報表生成過程中，要求負載中提供的重現間隔 |
RecurrenceCount |
報告的剩餘次數 |
CallbackUrl |
報表建立期間在資料負載中提供的回呼 URL |
CallbackMethod |
報表建立期間在請求載荷中提供的回呼方法 |
Format |
報表建立過程中在請求負載中提供的報表檔案格式 |
EndTime |
在報表建立期間的請求承載中提供的結束時間。 只有當 ExecuteNow 設為 「True」 時才適用 |
TotalRecurrenceCount |
在建立報告時於請求負載中提供的 RecurrenceCount |
nextExecutionStartTime |
下一次報表執行開始的 UTC 時間戳 |
TotalCount |
Value 陣列中的記錄數目 |
StatusCode |
結果碼。 可能的值為 200、400、401、403、500 |
message |
執行 API 的狀態消息 |