更新时间:2024-05-09 GMT+08:00
分享

创建模板

功能介绍

创建模板

调试

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

URI

POST /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

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

模板名称

最小长度:3

最大长度:32

description

String

模板描述

最小长度:0

最大长度:1024

columns

Array of DatabaseColumnDto objects

数据库列信息

数组长度:1 - 100

表4 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

响应参数

状态码: 201

表5 响应Body参数

参数

参数类型

描述

id

String

模板id

请求示例

创建模板,模板名为demo-template,有一列名为colum1,类型为Long,值不可为null,且为主键,可搜索

https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/templates

{
  "name" : "demo-template",
  "description" : "description",
  "columns" : [ {
    "name" : "column1",
    "type" : "Long",
    "description" : "description",
    "nullable" : false,
    "primary" : true,
    "searchable" : true,
    "unique" : true,
    "tips" : "tips"
  } ]
}

响应示例

状态码: 201

CREATED

{
  "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码

相关文档