通用模板
February 26, 2024About 2 min
通用模板
SDK类名：/common/CommonTemplate;
通用模板 - 新建
SDK方法名：createCommonTemplate；
URL
/common_template/
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| common_template | Object | ||||
| template_name | String | 通用模板名称 | |||
| template_type | Number | 通用模板类型， 0：json字符串模板 | |||
| template_text | String | 通用模板文本内容（目前暂存json字符串） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | success | |||
| template_uuid | String | @uuid | |||
| msg | String |
通用模板 - 单个
SDK方法名：describeCommonTemplate；
URL
/common_template/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| template_uuid | String | 通用模板uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| common_template | Object | ||||
| template_uuid | String | @uuid | |||
| template_type | Number | 通用模板类型： 0：json字符串 | 0 | ||
| template_text | String | 通用模板内容 | @paragraph(10,20) | ||
| template_name | String | 通用模板id | @word(3, 5) | ||
| msg | String |
通用模板 - 修改
SDK方法名：modifyCommonTemplate；
URL
/common_template/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| common_template | Object | ||||
| template_name | String | 通用模板名称 | |||
| template_type | Number | 通用模板类型， 0：json字符串模板 | |||
| template_text | String | 通用模板文本内容（目前暂存json字符串） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | success | |||
| uuid | String | @uuid | |||
| msg | String |
通用模板 - 删除
SDK方法名：deleteCommonTemplate;
URL
/common_template
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| template_uuid | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| ret | Number | 200 |
通用模板 - 列表
SDK方法名：listCommonTemplate;
URL
/common_template
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| limit | Number | , 可选，不传就是全部 | 10 | ||
| page | Number | , 可选，不传就是全部 | 1 | ||
| search_field | String | , 可选，搜索字段 | |||
| search_value | String | , 可选，搜索字段对应值（可以模糊） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | 否 | @mock= | ||
| data | Object | 否 | |||
| total | Number | 否 | @mock=100, 规则总数 | 100 | |
| code | Number | 否 | @mock=0 | 0 | |
| info_list | Array | 否 | 50 | ||
| template_uuid | String | 否 | @mock=0DD4E727-70AB-62C6-BEB5-D012DFAE46E3, 备机节点uuid | 0DD4E727-70AB-62C6-BEB5-D012DFAE46E3 | |
| user_uuid | String | 否 | @mock=@pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]), 操作者用户名uuid | @pick(["1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC","1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC"]) | |
| template_name | String | 否 | @mock=template_name | task_name | |
| create_time | Number | 否 | @mock=1515568566, 任务创建时间 | @integer( 1627961021, 1628961021 ) | |
| template_type | Number | 否 | 比较任务类型: 旧类型：0：主任务，1：子任务 新类型：2：主任务，3：子任务 | 0 | |
| template_text | String | @mock=text | @paragraph( 10,20 ) | ||
| message | String | 否 | @mock=[0] success | [0] success | |
| ret | Number | 否 | @mock=200 | 200 |