根据条件分页获取模板V3
功能介绍
根据条件分页获取模板V3
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/templates/page
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 取值范围: 字符串长度32。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
params |
否 |
TemplatePageParam object |
参数解释: 模板分页参数 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
BasePageInfoTemplateV2 object |
参数解释: 返回体 取值范围: 不涉及 |
message |
String |
参数解释: 错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
参数解释: 每页显示的条目数量,最大支持200条 取值范围: 数字,范围1-200 |
list |
Array of TemplateV2 objects |
参数解释: 返回体 取值范围: 不涉及 |
offset |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 取值范围: 数字,范围0-100000 |
pages |
Integer |
参数解释: 总页数量 取值范围: 数字,范围1-100 |
size |
Integer |
参数解释: 列表个数 取值范围: 数字,范围1-200 |
total |
Long |
参数解释: 总数 取值范围: 数字 |
参数 |
参数类型 |
描述 |
---|---|---|
create_time |
String |
参数解释: 创建时间 取值范围: 固定日期格式yyyy-MM-dd HH:mm:ss |
creator_name |
String |
参数解释: 创建人名称。 取值范围: 大小写字母、数字、符号、中文。 |
creator_num |
String |
参数解释: 创建者,用户在IAM中的ID。 取值范围: 大小写字母、数字。 长度限制固定32位 |
description |
String |
参数解释: 描述 取值范围: 大小写字母、数字、符号、中文。 |
id |
String |
参数解释: id 主键 取值范围: 大小写字母、数字。 |
is_default |
String |
参数解释: 是否默认 取值范围: 大小写字母、数字。 |
mindmap |
String |
参数解释: 脑图json 取值范围: 大小写字母、数字、符号、中文。 |
name |
String |
参数解释: 名称 取值范围: 大小写字母、数字、符号、中文。 |
update_time |
String |
参数解释: 更新时间 取值范围: 固定日期格式yyyy-MM-dd HH:mm:ss |
editPermission |
Boolean |
参数解释: 编辑权限 取值范围: 布尔值,true|false |
deletePermission |
Boolean |
参数解释: 删除权限 取值范围: 布尔值,true|false |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
请求示例
根据条件分页获取模板V3
post https://{endpoint}/v3/b94c9a6947a44597891e0a7362e7383f/templates/page { "params" : { "creator_num" : "", "name" : "", "limit" : 9, "offset" : 1 } }
响应示例
状态码:200
OK
{ "code" : "success", "data" : { "total" : 1, "list" : [ { "id" : "66053737cb7d4cedb1b848f2dfa37f0c", "description" : "", "mindmap" : null, "name" : "1", "editPermission" : true, "deletePermission" : true, "is_default" : null, "create_time" : "2025/01/10 10:43:56 GMT+08:00", "creator_name" : "user", "creator_num" : "efdb403066474ab08836b9eeaaa23bca", "update_time" : null } ], "offset" : 1, "limit" : 9, "pages" : 1, "size" : 1 }, "message" : null }
状态码:400
Bad Request
{ "error_code" : "TESTMIND.00021882", "error_msg" : "分支、计划id长度不合法,请稍后重试" }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。