获取商业市场的报表 API

此 API 获取已计划的所有报表。

请求语法

方法	请求 URI
GET	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	string	Application/JSON

路径参数

无

查询参数

参数名称	必需	类型	描述
reportId	否	string	筛选以获取仅包含 reportId 此参数中给定的报告的详细信息。 reportId可以通过用分号分隔多个（;)
reportName	否	string	通过筛选来仅获取具有此参数中指定的 reportName 的报表的详细信息
queryId	否	boolean	在响应中包括预定义的系统查询

术语表

无

响应

响应有效负载以 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 后显示的状态消息