文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 项目配置/ 获取项目级别全局配置
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

获取项目级别全局配置

功能介绍

获取项目级别全局配置

URI

GET /v4/projects/{project_id}/testcase/global/config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

对外时：success|error; 对内时：ok|failed

result

ResultValueTestcaseProjectConfig object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

对内接口才有此属性
表4 ResultValueTestcaseProjectConfig

参数

参数类型

描述

total

Integer

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

value

TestcaseProjectConfig object

项目配置信息对象

reason

String

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

page_size

Integer

每页展示数量

page_no

Integer

页码

has_more

Boolean

是否有更多
表5 TestcaseProjectConfig

参数

参数类型

描述

status_config

Array of NameAndIdVo objects

用例状态配置

result_config

Array of NameAndIdVo objects

用例结果配置

module_list

Array of NamePathAndPathVo objects

模块列表

iter_list

Array of NameAndIdVo objects

迭代列表

service_type_list

Array of NameAndIdVo objects

服务类型列表

customized_field_list

Array of ProjectTestCaseFieldVo objects

自定义字段信息列表

username_list

Array of NameAndIdVo objects

用户信息列表

test_type_list

Array of NameAndIdVo objects

测试类型列表
表6 NamePathAndPathVo

参数

参数类型

描述

id

String

ID

name

String

名称

path

String

路径id

path_name

String

模块路径名称
表7 ProjectTestCaseFieldVo

参数

参数类型

描述

uri

String

项目用例自定义字段主键

name

String

项目用例自定义字段名称

type

String

项目用例自定义字段类型（单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user）

options

String

项目用例自定义字段选项（数字类型时，数组两个值，第一个是最小值，第二个是最大值）

description

String

项目用例自定义字段描述

creator

String

项目用例自定义字段创建人

updater

String

项目用例自定义字段更新人

custom_field_id

Integer

项目用例自定义字段id（1-25数字）

custom_field_name

String

项目用例自定义字段名称

custom_field_param

String

项目用例自定义字段入参或者返回参数名称

type_name

String

项目用例自定义字段类型国际化名称

create_time

String

项目用例自定义字段创建时间

create_time_timestamp

Long

项目用例自定义字段创建时间时间戳

update_time

String

项目用例自定义字段更新时间

update_time_timestamp

Long

项目用例自定义字段更新时间时间戳

project_uuid

String

项目id
表8 NameAndIdVo

参数

参数类型

描述

id

String

ID

name

String

名称
表9 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

获取项目级别全局配置

post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/testcase/global/config

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "status_config" : [ {
        "id" : "0",
        "name" : "新建"
      }, {
        "id" : "5",
        "name" : "设计中"
      }, {
        "id" : "6",
        "name" : "测试中"
      }, {
        "id" : "7",
        "name" : "完成"
      } ],
      "result_config" : [ {
        "id" : "0",
        "name" : "成功"
      }, {
        "id" : "1",
        "name" : "失败"
      }, {
        "id" : "2",
        "name" : "待核查"
      }, {
        "id" : "3",
        "name" : "不可用"
      }, {
        "id" : "4",
        "name" : "阻塞"
      }, {
        "id" : "5",
        "name" : "执行中"
      }, {
        "id" : "6",
        "name" : "停止"
      } ],
      "module_list" : [ {
        "id" : "1065298701371482112",
        "name" : "模块",
        "path" : "1065298701371482112",
        "path_name" : "模块"
      }, {
        "id" : "-2",
        "name" : "未设置",
        "path" : "-2",
        "path_name" : "未设置"
      } ],
      "iter_list" : [ {
        "id" : "-2",
        "name" : "未设置"
      }, {
        "id" : "1065298855273078784",
        "name" : "s1"
      } ],
      "service_type_list" : [ {
        "id" : "32",
        "name" : "车BU功能自动化"
      }, {
        "id" : "0",
        "name" : "手工测试"
      }, {
        "id" : "1",
        "name" : "接口自动化"
      }, {
        "id" : "8",
        "name" : "WebUI自动化"
      }, {
        "id" : "11",
        "name" : "性能自动化"
      } ],
      "customized_field_list" : [ ],
      "username_list" : [ {
        "id" : "ffb8caecd62b41c7929121c181d11064",
        "name" : "小娅的小号"
      } ],
      "test_type_list" : [ {
        "id" : "22",
        "name" : "可靠性测试"
      }, {
        "id" : "1",
        "name" : "功能性测试"
      }, {
        "id" : "2",
        "name" : "兼容性测试"
      }, {
        "id" : "14",
        "name" : "安全性测试"
      }, {
        "id" : "4",
        "name" : "性能测试"
      }, {
        "id" : "15",
        "name" : "易用性测试"
      }, {
        "id" : "21",
        "name" : "可服务性测试"
      } ]
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 项目配置

相关文档