更新时间:2025-08-30 GMT+08:00
分享

创建字典

功能介绍

创建字典数据

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/configurations/dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

X-Language

String

用户当前语言环境

表3 请求Body参数

参数

是否必选

参数类型

描述

dict_list

Array of DictionaryCreate objects

字典列表

is_built_in

Boolean

是否创建内置字典

表4 DictionaryCreate

参数

是否必选

参数类型

描述

version

String

版本号

dict_id

String

字典id

dict_key

String

字典key

dict_code

String

字典code码

dict_val

String

字典值

dict_pkey

String

字典key

dict_pcode

String

字典关联的父code

scope

String

字典所属领域

description

String

字典描述信息

extend_field

Object

额外字段

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

language

String

用户当前语言环境

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

success_list

Array of Dictionary objects

正常字典列表

failed_list

Array of Dictionary objects

异常字典列表

表6 Dictionary

参数

参数类型

描述

id

String

uuid

version

String

版本号

dict_id

String

字典id

dict_key

String

字典key

dict_code

String

字典code

dict_val

String

字典值

dict_pkey

String

字典关联的父key

dict_pcode

String

字典关联的父code

create_time

String

创建时间

update_time

String

更新时间

publish_time

String

发布时间

scope

String

字典所属领域

description

String

字典描述信息

extension_field

Object

额外字段

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

language

String

用户当前语言环境

请求示例

响应示例

状态码

状态码

描述

200

字典列表

错误码

请参见错误码

相关文档