文档首页/ 应用与数据集成平台 ROMA Connect/ API参考（阿布扎比区域）/ 公共资源API/ 字典管理/ 创建字典
更新时间：2022-12-05 GMT+08:00
查看PDF
分享

创建字典

功能介绍

创建字典

URI

POST /v2/{project_id}/instances/{instance_id}/dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID

最小长度：0

最大长度：64

project_id

是

String

项目ID

最小长度：0

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

最小长度：1

最大长度：100000
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

字典名称

  • 字符集：中文、英文字母、数字、下划线和空格

  • 约束：实例下唯一

remark

否

String

字典描述

code

是

String

字典编码

  • 字符集：英文字母、数字、下划线和空格

  • 约束：实例下唯一

order

否

Integer

字典排序，值越小顺序越靠前

extend_one

否

String

字典扩展字段1

  • 字符集：中文、英文字母、数字、下划线和空格

extend_two

否

String

字典扩展字段2

  • 字符集：中文、英文字母、数字、下划线和空格

parent_code

否

String

父字典编码,为空时代表自身就是最顶级字典

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

id

String

字典ID

最小长度：0

最大长度：64

name

String

字典名称

  • 字符集：中文、英文字母、数字、下划线和空格

  • 约束：实例下唯一

remark

String

字典描述

code

String

字典编码

  • 字符集：英文字母、数字、下划线和空格

  • 约束：实例下唯一

extend_one

String

字典扩展字段1

  • 字符集：中文、英文字母、数字、下划线和空格

extend_two

String

字典扩展字段2

  • 字符集：中文、英文字母、数字、下划线和空格

parent_code

String

父字典编码,为空时代表自身就是最顶级字典

type

String

字典类型

  • system: 代表系统内置字典,用户可编辑但不可删除

  • user: 代表用户创建字典

create_time

Number

创建时间

最小值：1

最大值：128

update_time

Number

更新时间

最小值：1

最大值：128

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：1

最大长度：128

error_msg

String

错误消息

最小长度：1

最大长度：128

error_details

String

具体错误消息

最小长度：1

最大长度：128

request_id

String

请求处理ID

最小长度：1

最大长度：128

suggestion

String

处理建议

最小长度：1

最大长度：128

请求示例

{
  "name" : "Dictionary name",
  "remark" : "Dictionary description",
  "code" : "13760c1fe8655e61209b75665e9bef43",
  "order" : "1",
  "extend_one" : "Dictionary extended field 1",
  "extend_two" : "Dictionary extended field 2",
  "parent_code" : ""
}

响应示例

状态码： 201

OK

{
  "id" : "string",
  "name" : "string",
  "remark" : "string",
  "code" : "string",
  "extend_one" : "string",
  "extend_two" : "string",
  "parent_code" : "string",
  "type" : "system",
  "create_time" : "2019-12-06T06:49:04Z",
  "update_time" : "2019-12-06T06:49:04Z"
}

状态码： 400

Bad Request

{
  "error_code" : "ROMA.00014002",
  "error_msg" : "instance not found",
  "error_details" : "",
  "suggestion" : "",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

201

OK

400

Bad Request

错误码

请参见错误码。

父主题： 字典管理