获取商业市场的报表查询 API

获取报表查询 API 可获取可在报表中使用的所有查询。 默认情况下，它会获取所有系统定义的和用户定义的查询。

请求语法

方法	请求 URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

请求标头

页眉	类型	描述
授权	字符串	必需。 表单中的 Microsoft Entra 访问令牌 Bearer <token>
Content-Type	string	Application/JSON

路径参数

无

查询参数

参数名称	类型	必填	描述
queryId	string	否	进行筛选以仅获取此参数中给定 ID 的查询的详细信息
queryName	string	否	进行筛选以仅获取此参数中给定名称的查询的详细信息
IncludeSystemQueries	boolean	否	在响应中包含预定义的系统查询。 默认值为 True。
IncludeOnlySystemQueries	boolean	否	在响应中仅包括系统查询。 默认值为 False

请求有效负载

无

术语表

无

响应

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

响应代码：200、400、401、403、404、500

响应有效负载：

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

术语表

此表介绍了响应中元素的关键定义。

参数	描述
QueryId	查询的唯一 UUID
Name	创建查询时为查询指定的名称
Description	创建查询期间提供的说明
Query	报表查询字符串
Type	对于用户创建的查询，设置为 userDefined；对于预定义的系统查询，设置为 system
User	创建查询的用户 ID
CreatedTime	创建查询的时间
TotalCount	值数组中的数据集数目
StatusCode	结果代码。 可能的值为 200、400、401、403、500