文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试设置/ 查询需求模型树 - GetProjectModelConfig
更新时间：2026-07-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询需求模型树 - GetProjectModelConfig

功能介绍

此接口用于查询项目模型配置

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/model-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

value

RequirementModelConfigVo object

参数解释

请求返回的数据

取值范围

不涉及

status

String

请求处理状态

request_id

String

请求唯一id
表3 RequirementModelConfigVo

参数

参数类型

描述

project_uuid

String

项目唯一标识

feature_page_link_template

String

工作项功能页面跳转链接模板

category_layer_config

Array of CategoryLayerVo objects

工作项层级树

categories

Array of CategoryConfigVo objects

工作项属性列表
表4 CategoryLayerVo

参数

参数类型

描述

code

String

工作项code值

path

String

工作项子树路径

root_id

String

工作项树顶层节点id

children

Array of children objects

工作项树子树信息

parent_id

String

工作项树子树信息

id

String

工作项节点id

category_code

String

工作项code值

display_name

String

工作项展示名

test_able

Boolean

是否可测试，默认为true。为false时，需求不可关联用例、测试计划

display

Boolean

是否展示，默认为true。当此需求或此需求的子孙节点可展示时，此需求可展示；反之则不可展示
表5 children

参数

参数类型

描述

code

String

子树工作项code值

path

String

子树工作项子树路径

root_id

String

子树工作项树顶层节点id

children

Array of strings

工作项树子树信息

parent_id

String

工作项树子树信息

id

String

工作项节点id

category_code

String

工作项code值

display_name

String

工作项展示名

test_able

Boolean

是否可测试，默认为true。为false时，需求不可关联用例、测试计划

display

Boolean

是否展示，默认为true。当此需求或此需求的子孙节点可展示时，此需求可展示；反之则不可展示
表6 CategoryConfigVo

参数

参数类型

描述

code

String

工作项code值

prefix

String

工作项前缀值

enabled

String

是否启用

created_by

String

创建人

created_date

String

创建时间

modified_by

String

修改人

modified_date

Integer

修改时间

domain_id

String

工作项domain

icon

String

工作项图标展示值

color

String

工作项图标颜色

description

String

工作项描述信息

display_name

String

工作项展示名

definition_type

String

工作项定义类型

type_id

String

工作项类型id

tenant_id

String

租户id

region

String

区域

id

String

工作项id

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

查询需求模型树

GET https://{endpoint}/v4/projects/{project_id}/model-config

{
  "status" : "success",
  "request_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "result" : {
    "value" : {
      "project_uuid" : "bda4f30f4e6141019f3e234f60cee103",
      "feature_page_link_template" : "https://127.0.0.1:8080/ipdproject/openapi/v1/projects/ccc5da9d0cde4e8e8d702b687e55ab06/work/redirect?issue_id={issue_id}",
      "categories" : [ {
        "code" : "SR",
        "prefix" : "FR",
        "enabled" : "1",
        "created_by" : "efdb403066474ab08836b9eeaaa23bca",
        "created_date" : "1760959117268",
        "modified_by" : "efdb403066474ab08836b9eeaaa23bca",
        "modified_date" : 1760959117268,
        "domain_id" : "efdb403066474ab08836b9eeaaa23bca",
        "icon" : "IR",
        "color" : "#F66F6A",
        "description" : "原始需求",
        "display_name" : "研发需求",
        "definition_type" : "1",
        "type_id" : "10026",
        "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
        "region" : "cn-north-7",
        "id" : "1173315595427688448"
      } ],
      "category_layer_config" : [ {
        "code" : "3c1a0e54cac34a1b831cbb2706e77dd8",
        "path" : "/1173326082484023299/1173326082484023300",
        "root_id" : "1173326082484023299",
        "children" : [ ],
        "parent_id" : "1173326082484023299",
        "id" : "1173326082484023300",
        "category_code" : "DR",
        "display_name" : "研发需求",
        "test_able" : true,
        "display" : true
      } ]
    }
  },
  "error" : null
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "request_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "result" : {
    "value" : {
      "project_uuid" : "bda4f30f4e6141019f3e234f60cee103",
      "feature_page_link_template" : "https://127.0.0.1:8080/ipdproject/openapi/v1/projects/ccc5da9d0cde4e8e8d702b687e55ab06/work/redirect?issue_id={issue_id}",
      "categories" : [ {
        "code" : "SR",
        "prefix" : "FR",
        "enabled" : "1",
        "created_by" : "efdb403066474ab08836b9eeaaa23bca",
        "created_date" : "1760959117268",
        "modified_by" : "efdb403066474ab08836b9eeaaa23bca",
        "modified_date" : 1760959117268,
        "domain_id" : "efdb403066474ab08836b9eeaaa23bca",
        "icon" : "IR",
        "color" : "#F66F6A",
        "description" : "原始需求",
        "display_name" : "研发需求",
        "definition_type" : "1",
        "type_id" : "10026",
        "tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
        "region" : "cn-north-7",
        "id" : "1173315595427688448"
      } ],
      "category_layer_config" : [ {
        "code" : "3c1a0e54cac34a1b831cbb2706e77dd8",
        "path" : "/1173326082484023299/1173326082484023300",
        "root_id" : "1173326082484023299",
        "children" : [ ],
        "parent_id" : "1173326082484023299",
        "id" : "1173326082484023300",
        "category_code" : "DR",
        "display_name" : "研发需求",
        "test_able" : true,
        "display" : true
      } ]
    }
  },
  "error" : null
}

状态码：400

Bad Request

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码：500

Internal Server Error

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试设置

相关文档