新增映射 - CreateMapper
功能介绍
新增映射
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
The id, display only |
|
name |
否 |
String |
The name, display only |
|
project_id |
否 |
String |
The id, display only |
|
workspace_id |
否 |
String |
The id, display only |
|
dataclass_id |
是 |
String |
The id, display only |
|
data_source |
否 |
String |
数据源 |
|
status |
否 |
String |
状态(enabled,disabled) |
|
description |
否 |
String |
The description, display only |
|
create_time |
否 |
String |
Create time |
|
creator_id |
否 |
String |
Creator id value |
|
creator_name |
否 |
String |
Creator name value |
|
update_time |
否 |
String |
Update time |
|
modifier_id |
否 |
String |
Modifier id value |
|
modifier_name |
否 |
String |
Modifier name value |
|
mapper |
是 |
DpeMappingDetail object |
映射信息 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
The id, display only |
|
name |
否 |
String |
The name, display only |
|
project_id |
否 |
String |
The id, display only |
|
workspace_id |
否 |
String |
The id, display only |
|
dataclass_id |
否 |
String |
The id, display only |
|
dataclass_name |
否 |
String |
数据类名称 |
|
mapper_type_id |
否 |
String |
The id, display only |
|
dpe_info |
否 |
DpeInfo object |
分类信息 |
|
create_time |
否 |
String |
Create time |
|
creator_id |
否 |
String |
Creator id value |
|
creator_name |
否 |
String |
Creator name value |
|
update_time |
否 |
String |
Update time |
|
modifier_id |
否 |
String |
Modifier id value |
|
modifier_name |
否 |
String |
Modifier name value |
|
mapper_field_list |
否 |
Array of DpeMappingFieldDetail objects |
list of mapper field |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
The id, display only |
|
name |
否 |
String |
The name, display only |
|
project_id |
否 |
String |
The id, display only |
|
workspace_id |
否 |
String |
The id, display only |
|
dataclass_id |
否 |
String |
The id, display only |
|
dataclass_name |
否 |
String |
数据类名称 |
|
classifier_id |
否 |
String |
关联分类ID |
|
status |
否 |
String |
状态 |
|
complete_degree |
否 |
String |
完成度 |
|
instance_num |
否 |
Integer |
关联实例数 |
|
description |
否 |
String |
The description, display only |
|
update_time |
否 |
String |
Update time |
|
create_time |
否 |
String |
Create time |
|
creator_id |
否 |
String |
Creator id value |
|
creator_name |
否 |
String |
Creator name value |
|
modifier_id |
否 |
String |
Modifier id value |
|
modifier_name |
否 |
String |
Modifier name value |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
The id, display only |
|
project_id |
否 |
String |
The id, display only |
|
workspace_id |
否 |
String |
The id, display only |
|
dataclass_id |
否 |
String |
The id, display only |
|
mapping_id |
否 |
String |
The id, display only |
|
mapper_id |
否 |
String |
The id, display only |
|
default_value |
否 |
String |
默认值 |
|
target_key |
否 |
String |
目标字段 |
|
expression |
否 |
String |
表达式 |
|
create_time |
否 |
String |
Create time |
|
update_time |
否 |
String |
Update time |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
|
data |
DpeMappingDetail object |
映射信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
The id, display only |
|
name |
String |
The name, display only |
|
project_id |
String |
The id, display only |
|
workspace_id |
String |
The id, display only |
|
dataclass_id |
String |
The id, display only |
|
dataclass_name |
String |
数据类名称 |
|
mapper_type_id |
String |
The id, display only |
|
dpe_info |
DpeInfo object |
分类信息 |
|
create_time |
String |
Create time |
|
creator_id |
String |
Creator id value |
|
creator_name |
String |
Creator name value |
|
update_time |
String |
Update time |
|
modifier_id |
String |
Modifier id value |
|
modifier_name |
String |
Modifier name value |
|
mapper_field_list |
Array of DpeMappingFieldDetail objects |
list of mapper field |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
The id, display only |
|
name |
String |
The name, display only |
|
project_id |
String |
The id, display only |
|
workspace_id |
String |
The id, display only |
|
dataclass_id |
String |
The id, display only |
|
dataclass_name |
String |
数据类名称 |
|
classifier_id |
String |
关联分类ID |
|
status |
String |
状态 |
|
complete_degree |
String |
完成度 |
|
instance_num |
Integer |
关联实例数 |
|
description |
String |
The description, display only |
|
update_time |
String |
Update time |
|
create_time |
String |
Create time |
|
creator_id |
String |
Creator id value |
|
creator_name |
String |
Creator name value |
|
modifier_id |
String |
Modifier id value |
|
modifier_name |
String |
Modifier name value |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
The id, display only |
|
project_id |
String |
The id, display only |
|
workspace_id |
String |
The id, display only |
|
dataclass_id |
String |
The id, display only |
|
mapping_id |
String |
The id, display only |
|
mapper_id |
String |
The id, display only |
|
default_value |
String |
默认值 |
|
target_key |
String |
目标字段 |
|
expression |
String |
表达式 |
|
create_time |
String |
Create time |
|
update_time |
String |
Update time |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
新增映射响应 |
|
400 |
请求异常返回报文 |
错误码
请参见错误码。