获取租户的项目模板设置 - QueryDomainProjectTemplate
功能介绍
此接口用于获取租户的项目模板设置信息
调用方法
请参见如何调用API。
URI
GET /v4/{domain_id}/project/templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释 租户ID，唯一标识一个租户 取值范围 字符串 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 符合条件的所有记录数 |
| value | DomainProjectTemplateVo object | 租户项目模板 |
| reason | String | 错误信息 |
| page_size | Integer | 每页展示条数 |
| page_no | Integer | 页码 |
| has_more | Boolean | 是否有更多 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uri | String | 项目模板唯一标识 |
| domain_id | String | 项目模板归属租户 |
| name | String | 项目模板名称 |
| description | String | 项目模板描述 |
| field_vo_list | Array of ProjectTemplateFieldVo objects | 项目模板字段列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| table_field_name | String | 字段名称 |
| value_type | String | 字段类型 |
| is_display | Integer | 是否显示 |
| is_required | Integer | 是否必填 |
| is_lock | Integer | 是否锁定 |
| sort_numb | Integer | 排序编号 |
| default_value | String | 默认值 |
| custom_field_uri | String | 扩展字段URI |
| resource_type | String | 资源类型 |
| description | String | 描述 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 接口调用失败错误码 取值范围 不涉及 |
| error_msg | String | 参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
获取租户的项目模板设置
get https://{endpoint}/v4/{domain_id}/project/templates
{
"domain_id" : "domain-uuid-001"
} 响应示例
状态码：200
OK
{
"total" : 1,
"value" : {
"template_uri" : "template-001",
"template_name" : "默认模板",
"description" : "默认项目模板"
},
"reason" : "",
"page_size" : 20,
"page_no" : 1,
"has_more" : false
} 状态码：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 |
错误码
请参见错误码。
