# 保存单个自定义报表 - CreateReport #### 功能介绍 此接口用于保存单个自定义报表，同页面 测试 -\> 测试质量看板 -\> 右侧展示看板，下滑页面，找到自定义测试报表 -\> 点击添加报表，选择自定义报表 -\> 输入必填值，点击保存 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /GT3KServer/v4/{project_id}/versions/{version_id}/custom-reports 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 字符串类型，长度32位字符 **取值范围**: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 **默认取值**: 不涉及 | | version_id | 是 | String | **参数解释** 版本uri **约束限制** 不涉及 **取值范围** 11-34位字母/数字 **默认取值** 不涉及 **获取方法**： 从GET /v4/projects/{project_id}/iterator-infos的返回字段获取 从GET /v1/{project_id}/branches 的返回字段获取 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释** 报表名称 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | type | 是 | Integer | **参数解释** 报表类型 **约束限制** 不涉及 **取值范围** 1：首页用例库， 2：质量报告 **默认取值** 不涉及 | | workpiece_type | 是 | String | **参数解释** 工件类型 **约束限制** 不涉及 **取值范围** (用例：case,测试套：suite) **默认取值** 不涉及 | | analysis_dim_row | 是 | String | **参数解释** 分析维度 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | compare_dim_column | 是 | String | **参数解释** 对比维度 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | filter | 是 | [ReportFilter] object | **参数解释** 过滤条件 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | 表4ReportFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | creatorIds | 否 | String | **参数解释** 创建人 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | ownerIds | 否 | String | **参数解释** 所属人 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | ranks | 否 | String | **参数解释** 级别 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | releaseIds | 否 | String | **参数解释** releaseId **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | status | 否 | String | **参数解释**: 状态 **取值范围**: - -1，删除。 - 0，新建。 - 5，设计中。 - 6，测试中。 - 7，完成。 - -2，未设置。 | | moduleIds | 否 | String | **参数解释** 级别 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | results | 否 | String | **参数解释** 结果 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | labelIds | 否 | String | **参数解释** 标签 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | startTime | 是 | String | **参数解释** 开始时间 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | endTime | 是 | String | **参数解释** 结束时间 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | isAssociateIssue | 否 | String | **参数解释** 是否关联需求 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | featureUris | 是 | String | **参数解释** 目录uris **约束限制** 不涉及 **取值范围** 大小限制1000内 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | String | **参数解释** 请求返回的数据 **取值范围** 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释**: 业务失败的错误码 **取值范围**: 不涉及 | | reason | String | **参数解释**: 业务失败的提示内容 **取值范围**: 不涉及 | #### 请求示例 ``` post https://{endpoint}/GT3KServer/v4/dc3f9aa646ad4707831080d3fcce474d/versions/v92s00010db208e5/custom-reports { "name" : "name", "type" : 0, "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", "featureUris" : "string" } } ``` #### 响应示例 **状态码：200** OK ``` { "value" : "v90100010sa5vvsa" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cloudtest.v1.region.CloudtestRegion; import com.huaweicloud.sdk.cloudtest.v1.*; import com.huaweicloud.sdk.cloudtest.v1.model.*; public class CreateReportSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CloudtestClient client = CloudtestClient.newBuilder() .withCredential(auth) .withRegion(CloudtestRegion.valueOf("")) .build(); CreateReportRequest request = new CreateReportRequest(); request.withVersionId("{version_id}"); request.withProjectId("{project_id}"); OprReportInfo body = new OprReportInfo(); ReportFilter filterbody = new ReportFilter(); filterbody.withCreatorIds("1445148") .withOwnerIds("1445148") .withRanks("1") .withReleaseIds("1") .withStatus("1") .withModuleIds("1") .withResults("1") .withLabelIds("1") .withStartTime("2020-09-08 10:42:07") .withEndTime("2020-09-08 10:42:07") .withIsAssociateIssue("true"); body.withFilter(filterbody); body.withCompareDimColumn("name"); body.withAnalysisDimRow("name"); body.withWorkpieceType("case"); body.withType(0); body.withName("name"); request.withBody(body); try { CreateReportResponse response = client.createReport(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcloudtest.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CloudtestClient.new_builder() \ .with_credentials(credentials) \ .with_region(CloudtestRegion.value_of("")) \ .build() try: request = CreateReportRequest() request.version_id = "{version_id}" request.project_id = "{project_id}" filterbody = ReportFilter( creator_ids="1445148", owner_ids="1445148", ranks="1", release_ids="1", status="1", module_ids="1", results="1", label_ids="1", start_time="2020-09-08 10:42:07", end_time="2020-09-08 10:42:07", is_associate_issue="true" ) request.body = OprReportInfo( filter=filterbody, compare_dim_column="name", analysis_dim_row="name", workpiece_type="case", type=0, name="name" ) response = client.create_report(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.CreateReportRequest{} request.VersionId = "{version_id}" request.ProjectId = "{project_id}" creatorIdsFilter:= "1445148" ownerIdsFilter:= "1445148" ranksFilter:= "1" releaseIdsFilter:= "1" statusFilter:= "1" moduleIdsFilter:= "1" resultsFilter:= "1" labelIdsFilter:= "1" startTimeFilter:= "2020-09-08 10:42:07" endTimeFilter:= "2020-09-08 10:42:07" isAssociateIssueFilter:= "true" filterbody := &model.ReportFilter{ CreatorIds: &creatorIdsFilter, OwnerIds: &ownerIdsFilter, Ranks: &ranksFilter, ReleaseIds: &releaseIdsFilter, Status: &statusFilter, ModuleIds: &moduleIdsFilter, Results: &resultsFilter, LabelIds: &labelIdsFilter, StartTime: &startTimeFilter, EndTime: &endTimeFilter, IsAssociateIssue: &isAssociateIssueFilter, } compareDimColumnOprReportInfo:= "name" analysisDimRowOprReportInfo:= "name" workpieceTypeOprReportInfo:= "case" typeOprReportInfo:= int32(0) nameOprReportInfo:= "name" request.Body = &model.OprReportInfo{ Filter: filterbody, CompareDimColumn: &compareDimColumnOprReportInfo, AnalysisDimRow: &analysisDimRowOprReportInfo, WorkpieceType: &workpieceTypeOprReportInfo, Type: &typeOprReportInfo, Name: &nameOprReportInfo, } response, err := client.CreateReport(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=CreateReport)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。