更新商业市场的报表 API

此 API 可帮助你修改报表参数。

请求语法

方法	请求 URI
PUT	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport/{Report ID}

请求标头

标头	类型	说明
授权	字符串	必需。 表单中的 Microsoft Entra 访问令牌 Bearer <token>
Content-Type	string	Application/JSON

路径参数

无

查询参数

参数名称	必须	类型​​	说明
reportId	是	string	要修改的报表的 ID

请求有效负载

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

术语表

此表列出了请求有效负载中元素的关键定义。

参数	必需	说明	允许的值
ReportName	是	要分配给报表的名称	string
Description	否	创建的报表的说明	string
StartTime	是	开始生成报表的时间戳	string
RecurrenceInterval	否	应以小时为单位生成报表的频率。 最小值为 4	integer
RecurrenceCount	否	要生成的报表数。 默认值为无限	integer
Format	是	导出的文件的文件格式。 默认值为 CSV。	CSV/TSV
CallbackUrl	是	要在生成报表时调用的 https 回调 URL	string
CallbackMethod	否	可以使用回调 URL 配置的 Get/Post 方法	GET/POST
endTime	否	报表生成将结束的 UTC 时间戳。 格式应为 yyyy-MM-ddTHH:mm:ssZ	string

术语表

无

响应

响应有效负载的结构如下：

响应代码：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 后显示的状态消息