文档首页/ 医疗智能体/ API参考/ API（医疗智能体平台）/ 数据库管理/ 模板管理/ 查询模板列表
更新时间：2024-05-09 GMT+08:00
查看PDF
分享

查询模板列表

功能介绍

查询模板列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

是

String

平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。

最小长度：1

最大长度：128

project_id

是

String

华为云项目ID，您可以从获取项目ID中获取。

最小长度：1

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度：1

最大长度：32768

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

count

Integer

模板总数

templates

Array of TemplateRsp objects

模板列表
表4 TemplateRsp

参数

参数类型

描述

id

String

模板id

name

String

模板名称

description

String

模板描述

source_project_name

String

来源项目名称

source_project_id

String

来源项目id

source_template_id

String

来源模板id

creator

String

创建者

columns

Array of DatabaseColumnDto objects

数据库列信息列表

create_time

String

创建时间

primary_key

String

主键

is_prefab

Boolean

是否是预置模板
表5 DatabaseColumnDto

参数

参数类型

描述

name

String

列名

最小长度：1

最大长度：55

type

String

列类型

枚举值：

  • Long

  • String

  • Double

description

String

列描述信息

最小长度：0

最大长度：1024

nullable

Boolean

列是否允许为空

primary

Boolean

是否作为主键

searchable

Boolean

是否可查询

unique

Boolean

是否唯一

tips

String

查询参数格式的提示信息

最小长度：0

最大长度：1024

请求示例

无

响应示例

状态码： 200

OK

{
  "count" : 1,
  "templates" : [ {
    "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "name" : "demo-template",
    "description" : "description",
    "source_project_name" : "source project",
    "source_project_id" : "86e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "source_template_id" : "66e0f1b0-ac10-46a5-8fa7-b26831d7d488",
    "creator" : "demo-user",
    "columns" : [ {
      "name" : "column1",
      "type" : "Long",
      "description" : "description",
      "nullable" : false,
      "primary" : true,
      "searchable" : true,
      "unique" : true,
      "tips" : "tips"
    } ],
    "create_time" : "2021-01-29T09:10:27Z",
    "primary_key" : "ID,GROUP",
    "is_prefab" : false
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 模板管理

相关文档