文档首页> 测试计划 CodeArts TestPlan> API参考> API> 测试报表管理> 实时计算单个自定义报表
更新时间：2024-02-19 GMT+08:00
查看PDF
分享

实时计算单个自定义报表

功能介绍

实时计算单个自定义报表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v4/{project_id}/versions/{plan_id}/custom-reports/generate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

plan_id

是

String

分支/计划id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

报表名称

workpiece_type

否

String

工件类型(用例：case,测试套：suite)

analysis_dim_row

否

String

分析维度,取值需为:CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷),EXECUTETIMES(执行次数)

compare_dim_column

是

String

对比维度,取值需为(必填):CREATORID(创建人),OWNERID(处理人),RANK(级别),RELEASEID(迭代),STATUS(状态),MODULEID(模块),RELEASEDEV(版本号),RESULT(结果),EXECUTOR(执行人),ASSOCIATEISSUE(关联工作项),ASSOCIATEDEFECT(关联缺陷)

filter

否

ReportFilter object

过滤条件
表4 ReportFilter

参数

是否必选

参数类型

描述

creatorIds

否

String

创建人

ownerIds

否

String

所属人

ranks

否

String

级别

releaseIds

否

String

releaseId

status

否

String

状态

moduleIds

否

String

级别

results

否

String

结果

labelIds

否

String

标签

startTime

否

String

开始时间

endTime

否

String

结束时间

isAssociateIssue

否

String

是否关联需求

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueCustomReportListVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。
表6 ResultValueCustomReportListVo

参数

参数类型

描述

total

Integer

起始记录数大于实际总条数时，值为0，分页请求才有此值

value

CustomReportListVo object

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容，对内接口才有此值

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表7 CustomReportListVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

filter

ReportFilter object

过滤条件

workpiece_type

String

工件类型(用例：case,测试套：task)

analysis_dimension

String

分析维度

compare_dimension

String

对比维度

chart_data

Array of ReportChartDataVo objects

报表数据
表8 ReportFilter

参数

参数类型

描述

creatorIds

String

创建人

ownerIds

String

所属人

ranks

String

级别

releaseIds

String

releaseId

status

String

状态

moduleIds

String

级别

results

String

结果

labelIds

String

标签

startTime

String

开始时间

endTime

String

结束时间

isAssociateIssue

String

是否关联需求
表9 ReportChartDataVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

analyze_dim

ReportDimVo object

对比维度数据

compare_dim

Array of ReportDimVo objects

对比维度数据
表10 ReportDimVo

参数

参数类型

描述

id

String

id

name

String

名称

value

Integer

值
表11 ApiError

参数

参数类型

描述

code

String

只有对外的接口才会返回此内容

reason

String

业务失败的提示内容

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

实时计算单个自定义报表

post https://{endpoint}/v4/projects/efdb403066474ab08836b9eeaaa23bca/versions/daiuyd9tqdxas/custom-reports/generate

{
  "name" : "name",
  "workpiece_type" : "case",
  "analysis_dim_row" : "name",
  "compare_dim_column" : "name",
  "filter" : {
    "creatorIds" : "1445148",
    "ownerIds" : "1445148",
    "ranks" : "1",
    "releaseIds" : "1",
    "status" : "1",
    "moduleIds" : "1",
    "results" : "1",
    "labelIds" : "1",
    "startTime" : "2020-09-08 10:42:07",
    "endTime" : "2020-09-08 10:42:07",
    "isAssociateIssue" : "true"
  }
}

响应示例

状态码： 200

OK

{
  "status" : "string",
  "result" : {
    "total" : 0,
    "value" : {
      "id" : "1",
      "name" : "报表名称",
      "filter" : {
        "creatorIds" : "1445148",
        "ownerIds" : "1445148",
        "ranks" : "1",
        "releaseIds" : "1",
        "status" : "1",
        "moduleIds" : "1",
        "results" : "1",
        "labelIds" : "1",
        "startTime" : "2020-09-08 10:42:07",
        "endTime" : "2020-09-08 10:42:07",
        "isAssociateIssue" : "true"
      },
      "workpiece_type" : "case",
      "analysis_dimension" : "AUTHOR",
      "compare_dimension" : "AUTHOR",
      "chart_data" : [ {
        "id" : "1",
        "name" : "报表名称",
        "analyze_dim" : {
          "id" : "1",
          "name" : "名称",
          "value" : 0
        },
        "compare_dim" : [ {
          "id" : "1",
          "name" : "名称",
          "value" : 0
        } ]
      } ]
    },
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : {
    "code" : "string",
    "reason" : "string"
  },
  "request_id" : "string"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理
分享：

    相关文档

    相关产品