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

实时计算单个自定义报表

功能介绍

实时计算单个自定义报表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

plan_id

是

String

参数解释:

测试计划id或测试版本ID，对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象，测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值

约束限制:

不涉及

取值范围:

长度11-34位字符（字母和数字）

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

name

否

String

参数解释:

自定义报表的名称，由用户定义，用于表示当前创建的自定义报表

约束限制:

不涉及

取值范围:

长度为3-128字符（中文或字母）

默认取值:

不涉及

workpiece_type

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

case/task

默认取值:

不涉及

analysis_dim_row

否

String

参数解释:

分析维度,为自定义报表X轴

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

compare_dim_column

否

String

参数解释:

对比维度,为自定义报表Y轴

约束限制:

需结合分析维度进行用例/测试套统计

取值范围:

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

默认取值:

不涉及

filter

否

ReportFilter object

过滤条件
表4 ReportFilter

参数

是否必选

参数类型

描述

creatorIds

否

String

参数解释:

自定义报表创建人用户ID，指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ownerIds

否

String

参数解释:

自定义报表所属人用户ID，指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ranks

否

String

参数解释:

测试用例级别，指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别，用逗号拼接

默认取值:

不涉及

releaseIds

否

String

参数解释:

需求管理中迭代计划的ID，指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个迭代ID，用逗号拼接

默认取值:

不涉及

status

否

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个状态ID，用逗号拼接

默认取值:

不涉及

moduleIds

否

String

参数解释:

需求管理中定义的模块ID，指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个模块，用逗号拼接

默认取值:

不涉及

results

否

String

参数解释:

测试用例结果的状态编码，指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个结果ID，用逗号拼接

默认取值:

不涉及

labelIds

否

String

参数解释:

测试用例关联的标签ID，指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个标签，用逗号拼接

默认取值:

不涉及

startTime

否

String

参数解释:

开始时间，指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

endTime

否

String

参数解释:

结束时间，指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

否

String

参数解释:

是否关联需求，指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及

响应参数

状态码： 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

参数解释:

自定义报表创建人用户ID，指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ownerIds

String

参数解释:

自定义报表所属人用户ID，指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ranks

String

参数解释:

测试用例级别，指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别，用逗号拼接

默认取值:

不涉及

releaseIds

String

参数解释:

需求管理中迭代计划的ID，指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个迭代ID，用逗号拼接

默认取值:

不涉及

status

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个状态ID，用逗号拼接

默认取值:

不涉及

moduleIds

String

参数解释:

需求管理中定义的模块ID，指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个模块，用逗号拼接

默认取值:

不涉及

results

String

参数解释:

测试用例结果的状态编码，指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个结果ID，用逗号拼接

默认取值:

不涉及

labelIds

String

参数解释:

测试用例关联的标签ID，指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个标签，用逗号拼接

默认取值:

不涉及

startTime

String

参数解释:

开始时间，指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

endTime

String

参数解释:

结束时间，指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

String

参数解释:

是否关联需求，指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及
表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

错误码

请参见错误码。

父主题： 测试报表管理

相关文档