取得商業市集報表 API

此 API 會取得已排程的所有報告。

要求語法

方法	要求 URI
獲取	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

請求標頭

標題	類型	描述
授權	字串	必填。 Microsoft Entra 存取令牌的格式 Bearer <token>
Content-Type	字串	Application/JSON

Path 參數

沒有

查詢參數

參數名稱	必要	類型	描述
reportId	不	字串	篩選以取得僅包含此自變數中所指定 reportId 報表的詳細數據。 可以用分號 (;) 分隔多個 reportId。
reportName	不	字串	篩選以取得僅包含此自變數中所指定 reportName 報表的詳細數據
queryId	不	布爾	在回應中包含預先定義的系統查詢

詞彙

沒有

回應

響應承載是以 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	在報表生成時的請求負載中提供的查詢標識碼
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 的狀態消息