说明

获取计划模版

url

https://api.tapd.cn/api/testx/plan/v1/namespaces/{namespace}/plan-templates

支持格式

JSON

HTTP请求方式

GET

请求参数

Request

字段名	必选	类型及范围	说明
Namespace	是	string	命名空间
PageInfo	否	PageInfo	分页信息(缺省获取全部)

pageinfo

字段名	必选	类型及范围	说明
Offset	是	uint32	分页偏移位置
Limit	是	uint32	每页数量

返回结果

{
    "Error": null,
    "Data": [
        {
            "Uid": "xxx",
            "Name": "默认模板",
            "DescName": "默认模板",
            "Description": "",
            "Audit": {
                "Creator": "",
                "Updater": "",
                "CreatedAt": "2025-06-30T16:55:31+08:00",
                "UpdatedAt": "2025-06-30T16:55:31+08:00",
                "Tenant": ""
            },
            "Fields": [
                {
                    "Uid": "xxx",
                    "Field": {
                        "Widget": "TEXT",
                        "Type": "STR",
                        "Uneditable": false,
                        "Name": "suoshuxiangmu",
                        "Label": "所属项目",
                        "Description": "xxx",
                        "Help": "",
                        "Visible": false,
                        "Required": false,
                        "Default": "",
                        "Choices": [],
                        "Flag": "CUSTOM",
                        "Order": 0,
                        "EncryptOption": null,
                        "ValueSource": null,
                        "Properties": [],
                        "IsRichText": false
                    },
                    "Default": "",
                    "VisibleScope": "LIST",
                    "Required": false,
                    "Width": 0,
                    "Order": 0,
                    "FieldUid": "11817"
                }
            ]
        }
    ],
    "TotalCount": 1
}

测试计划字段说明

Template

字段名	必选	类型及范围	说明
Uid	是	string	计划模板ID
Name	是	string	计划模板标识
DescName	是	string	显示名
Description	是	string	说明
Fields	是	repeated TemplateField	模板属性列表

TemplateField

字段名	必选	类型及范围	说明
Uid	是	string	属性ID
Field	是	PropertyDefinition	属性信息
Default	是	google.protobuf.Value	默认值
VisibleScope	是	VisibleScope	可见范围
Required	是	bool	是否必填
Width	是	uint32	宽度
Order	是	uint32	排序字段
FieldUid	是	string	临时属性UID(兼容旧接口)

VisibleScope

值	说明
NONE	不可见
LIST	列表中显示

PropertyDefinition

字段名	必选	类型及范围	说明
Widget	是	Widget	输入框类型
Type	是	Type	字段类型
Uneditable	是	bool	是否可编辑
Name	是	string	字段名称
Label	是	string	显示名称
Description	是	string	描述
Help	是	string	帮助信息
Visible	是	bool	是否显示
Required	是	bool	是否必填
Default	是	google.protobuf.Value	默认值
Choices	是	repeated ValueChoice	可选值列表
Flag	是	Flag	类型标志
Order	是	uint32	排序序号
ValueSource	否	PropertyValueSource	值来源
Properties	否	repeated PropertyDefinition	子属性
IsRichText	否	bool	是否富文本

Widget

枚举值	说明
TEXT	文本输入框
TEXTAREA	文本域
SELECT	下拉选择
MULTI_SELECT	多选下拉
USER	用户选择
MULTI_USER	多用户选择
RADIO	单选按钮
CHECKBOX	复选框
INTEGER	整数输入
FLOAT	浮点数输入
DATE	日期选择
DATETIME	日期时间选择
KEY_VALUE	键值对
MULTI_VALUE	多值
MULTI_KEY_VALUE	多键值对
TAPD	TAPD字段
ITERATION	迭代
STORY	需求
BUG	缺陷
VERSION	版本
SWITCH	开关

Type

枚举值	说明
STR	字符串
LONG	长整型
LIST_STR	字符串列表
MAP_STR_TO_STR	字符串映射

Flag

枚举值	说明
NONE	无标志
SYSTEM	系统属性
CUSTOM	自定义属性
EXTRA_EDIT	额外可编辑属性

ValueChoice

字段名	必选	类型及范围	说明
ID	是	uint32	选项ID
Label	是	string	显示标签
Value	是	google.protobuf.Value	选项值
Order	是	uint32	排序序号