跨源配置 API
调用方法请参见Open API文档中的调用方法描述。
1. 创建跨源资产配置
创建跨源资产配置。
接口URL
/open/route/createRoute?token=xxx&proejctId=xxx
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
请求Body参数
{
"routeConfig": {
"routeCode":"",//
"routeDesc":"",//跨源资产配置显示名
"remark":"",//配置说明
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源
"highOrWideEnum":"",//高宽表[high,wide]
// event
"configEntityIdColumn":""//主体列 //event&dim
"dataPartTypeEnum":""//数据分区方式[column_date_part|auto_push_logic][日期信息列|自定义下推逻辑]
"configDateColumn":""//日期信息列
"configDateFormat":""//日期信息格式
"configBusinessPushLogic":""//下推逻辑
"businessEventNameSelectEnum":""//事件名取值方式[val|raw_column][固定值|读取列值]
"configEventName":""//事件名称
"configEventNameColumn":""//事件名称列
"businessEventDateValueSelectEnum":""//事件时间取值方式[raw_column|expression][读取列值|自定义SQL]
"configEventTimeColumn":""//事件时间列
"configEventTimeLogic":""//事件时间逻辑
"businessEventZoneOffsetSelectEnum":""//事件时区取值方式[raw_column|val|expression][读取列值|固定值|自定义SQL]
"configEventTimeTZColumn":""//事件时区列
"configEventTimeTZ":""//事件时区
"configEventTimeTZLogic":""//事件时区逻辑
//tag
"configEntityColumn":"",//主体列
"configEntityName":"",//分析主体-- 提交分析主体显示名
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"configDateColumn":"",//日期信息列
"tagHistoryVersion":"",//标签日期版本[onlyHistory,onlyLast,historyAndLast]
"configTagDateZoneOffsetVal":"",//标签日期时区
"configDateFormat":"",//日期信息格式
//user
"configDataUpdateTimeColumn":"", //数据更新时间列
//dim
"configEntityIdColumn":""//主体列
"configEntityProp":"",//主体属性
"propType":"",// 主体属性类型
"timeUnitFormat":""// 时间粒度
},
"eventMappings": [
{
"routeCodeFromEvent":"",//跨源资产配置名称
"targetEventName":"",//输出事件名
"sourceEventList":"",//原始事件列表
"targetEventDesc":"",//输出事件显示名
"remark":"",//备注
},
],
"propMappings":[
{
"routeCodeFromProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型 [array_string]
"isPublic":true//是否公共属性
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记
}
],
"eventPropMap":[//
{
"routeCodeFromEventPropMap":""//跨源资产配置名称
"eventName":""//输出事件名
"propName":""//输出属性名
}
],
"tagMappings": [
{
"routeCodeFromTag":"",//跨源资产配置名称
"routeResourceKey":"",//原始标签名
"targetTagName":"",//输出标签名
"targetTagDesc":"",//输出标签显示名
"sqlExpression":"",//取值方式
"routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
"extRemark":"",//备注
"extValueZoneOffset":"",//值时区
"enumValues":["",]//枚举文件标记
},
],
"userPropMapping": [
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记
}
],
"dimPropMapping":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFromDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
"enumValues":["",]//枚举文件标记
}
]
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| routeConfig | - | Object | 是 | 跨源资产配置信息 |
| routeConfig.routeCode | route_v1 | String | 是 | 跨源资产配置名称(资产类型为user时 传user_entity_route) |
| routeConfig.routeDesc | 跨源资产配置 | String | 否 | 跨源资产配置显示名 |
| routeConfig.remark | 跨源资产配置说明 | String | 否 | 配置说明 |
| routeConfig.viewResourceRouteType | event | String | 是 | 资产类型,取值范围为[tag, event, user, dim] |
| routeConfig.modelTable | hive.ta.table_2321 | String | 是 | 数据源 |
| routeConfig.highOrWideEnum | wide | String | 是 | 高宽表,取值范围为[high, wide](事件类型仅支持宽表) |
| (event) | ||||
| routeConfig.configEntityIdColumn | entity_id | String | 否 | 主体列 (routeConfig.viewResourceRouteType=event|dim, 必填) |
| routeConfig.dataPartTypeEnum | column_date_part | String | 是 | 数据分区方式,取值范围为[column_date_part, auto_push_logic] |
| routeConfig.configDateColumn | #event_time | String | 否 | 日期信息列 (dataPartTypeEnum=column_date_part, 必填) |
| routeConfig.configDateFormat | yyyy-MM-dd | String | 否 | 日期信息格式(dataPartTypeEnum=column_date_part, 必填) |
| routeConfig.configBusinessPushLogic | String | 否 | 下推逻辑 (dataPartTypeEnum=auto_push_logic时,必填) | |
| routeConfig.businessEventNameSelectEnum | raw_column | String | 是 | 事件名取值方式,取值范围为[val, raw_column] |
| routeConfig.configEventName | login | String | 否 | 事件名称 (businessEventNameSelectEnum=val, 必填) |
| routeConfig.configEventNameColumn | #event_name | String | 否 | 事件名称列 (businessEventNameSelectEnum=raw_column, 必填) |
| routeConfig.businessEventDateValueSelectEnum | raw_column | String | 是 | 事件时间取值方式,取值范围为[raw_column, expression] |
| routeConfig.configEventTimeColumn | #event_time | String | 否 | 事件时间列 (businessEventDateValueSelectEnum=raw_column, 必填) |
| routeConfig.configEventTimeLogic | date_parse( "ev_time", '%Y-%m-%d %H:%i:%s' ) | String | 否 | 事件时间逻辑 (businessEventDateValueSelectEnum=expression, 必填) |
| routeConfig.businessEventZoneOffsetSelectEnum | raw_column | String | 是 | 事件时区取值方式,取值范围为[raw_column, val, expression] |
| routeConfig.configEventTimeTZColumn | #zone_offset | String | 否 | 事件时区列 (businessEventZoneOffsetSelectEnum=raw_column, 必填) |
| routeConfig.configEventTimeTZ | 8 | String | 否 | 事件时区 (businessEventZoneOffsetSelectEnum=val, 必填) |
| routeConfig.configEventTimeTZLogic | cast( substr( "zone_offset", 3, 9 ) as double ) | String | 否 | 事件时区逻辑 (businessEventZoneOffsetSelectEnum=expression, 必填) |
| (tag) | ||||
| routeConfig.configEntityColumn | entity_id | String | 是 | 主体列 |
| routeConfig.configEntityName | user_login | String | 是 | 分析主体-- 提交分析主体显示名 |
| routeConfig.configTagNameColumn | tag_name_col | String | 是 | 标签名称列 |
| routeConfig.configTagValueColumn | tag_value_col | String | 是 | 标签值列 |
routeConfig.tagHistoryVersion | onlyLast | String | 是 | 标签日期版本,取值范围为[onlyHistory,onlyLast,historyAndLast] |
| routeConfig.configDateColumn | #event_time | String | 否 | 日期信息列 (选填) 选择日期分区所在的列, 若日期版本为"仅最新版本"则无需填写 |
| routeConfig.configTagDateZoneOffsetVal | 8 | String | 否 | 标签日期时区 , 日期信息列不为空时必填 |
| routeConfig.configDateFormat | yyyy-MM-dd | String | 否 | 日期信息格式,日期信息列不为空时必填 |
| (user) | ||||
| routeConfig.configDataUpdateTimeColumn | #update_time | String | 否 | 数据更新时间列 |
| (dim) | ||||
| routeConfig.configEntityIdColumn | #id | 否 | 主体列 | |
| routeConfig.configEntityProp | #login | 否 | 主体属性 | |
| routeConfig.propType | userProp | Enum | 否 | 主体属性类型 [userProp, eventProp] |
| routeConfig.timeUnitFormat | DATE_STR_YEAR | Enum | 否 | 时间粒度 [DATE_STR_YEAR, DATE_STR_MONTH, DATE_STR_DAY, DATE_STR_HOUR, DATE_STR_MINUTE, DATE_STR_SECOND, DATE_STR_MILLISECOND] |
| - | ||||
| eventMappings | - | Array | - | |
| eventMappings.routeCodeFromEvent | route_v1 | String | 是 | 跨源资产配置名称 |
| eventMappings.targetEventName | login | String | 是 | 输出事件名 |
| eventMappings.sourceEventList | ( 'event_1' , 'event_2' ) | String | 否 | 原始事件列表 |
| eventMappings.targetEventDesc | 登录 | String | 否 | 输出事件显示名 |
| eventMappings.remark | OSS登录 | String | 否 | 备注 |
| - | ||||
| propMappings | - | Array | - | |
| propMappings.routeCodeFromProp | route_v1 | String | 是 | 跨源资产配置名称 |
| propMappings.sourcePropName | account | String | 否 | 原始属性名 |
| propMappings.targetPropName | account | String | 是 | 输出属性名 |
| propMappings.targetPropDesc | 账户 | String | 否 | 输出属性显示名 |
| propMappings.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| propMappings.targetPropTypeEnum | String | String | 是 | 输出属性类型[] |
| propMappings.isPublic | true | Boolean | 否 | 是否公共属性 |
| propMappings.propConfigRemark | - | String | 否 | 备注 |
| propMappings.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
| - | ||||
| eventPropMap | - | Array | - | |
| eventPropMap.routeCodeFromEventPropMap | route_v1 | String | 是 | 跨源资产配置名称 |
| eventPropMap.eventName | - | String | 是 | 输出事件名 |
| eventPropMap.propName | - | String | 是 | 输出属性名 |
| - | ||||
| tagMappings | - | Array | ||
| tagMappings.routeCodeFromTag | route_v1 | String | 是 | 跨源资产配置名称 |
| tagMappings.routeResourceKey | tag_1 | String | 否 | 原始标签名 |
| tagMappings.targetTagName | tag_name | String | 是 | 输出标签名 |
| tagMappings.targetTagDesc | tag_desc | String | 否 | 输出标签显示名 |
| tagMappings.sqlExpression | - | String | 否 | 取值方式 |
| tagMappings.routeSelectTypeEnum | number | String | 是 | 取值范围为[number,string,datetime,bool,array] |
| tagMappings.extRemark | - | String | 否 | 备注 |
| tagMappings.extValueZoneOffset | 8 | String | 否 | 值时区 |
| tagMappings.enumValues | ["t_1","t_2"] | List<String> | 否 | 枚举文件标记 |
| - | ||||
| userPropMapping | ||||
| userPropMapping.routeCodeFromUserProp | route_v1 | String | 是 | 跨源资产配置名称 |
| userPropMapping.sourcePropName | account | String | 否 | 原始属性名 |
| userPropMapping.targetPropName | account | String | 是 | 输出属性名 |
| userPropMapping.targetPropDesc | 账户 | String | 否 | 输出属性显示名 |
| userPropMapping.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| userPropMapping.targetPropTypeEnum | String | String | 是 | 输出属性类型[] |
| userPropMapping.propConfigRemark | - | String | 否 | 备注 |
| userPropMapping.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
| - | ||||
| dimPropMapping | ||||
| dimPropMapping.routeCodeFromDim | route_v1 | String | 是 | 跨源资产配置名称 |
| dimPropMapping.sourceNameFormDim | account | String | 否 | 原始属性名 |
| dimPropMapping.targetNameFromDim | account | String | 是 | 输出属性名 |
| dimPropMapping.targetDescFromDim | 账户 | String | 否 | 输出属性显示名 |
| dimPropMapping.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| dimPropMapping.targetTypeEnum | String | String | 是 | 输出属性类型[] |
| dimPropMapping.remark | - | String | 否 | 备注 |
| dimPropMapping.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
成功响应示例
{
"return_code": 0,
"return_message": "success"
}
2. 更新跨源资产配置
接口URL
/open/route/updateRoute?token=xxx
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
请求Body参数
{
"routeConfig": {
"routeCode":"",//
"routeDesc":"",//跨源资产配置显示名
"remark":"",//配置说明
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源
"highOrWideEnum":"",//高宽表[high,wide]
//event
"configEntityIdColumn":""//主体列
"dataPartTypeEnum":""//数据分区方式[column_date_part|auto_push_logic][日期信息列|自定义下推逻辑]
"configDateColumn":""//日期信息列
"configDateFormat":""//日期信息格式
"configBusinessPushLogic":""//下推逻辑
"businessEventNameSelectEnum":""//事件名取值方式[val|raw_column][固定值|读取列值]
"configEventName":""//事件名称
"configEventNameColumn":""//事件名称列
"businessEventDateValueSelectEnum":""//事件时间取值方式[raw_column|expression][读取列值|自定义SQL]
"configEventTimeColumn":""//事件时间列
"configEventTimeLogic":""//事件时间逻辑
"businessEventZoneOffsetSelectEnum":""//事件时区取值方式[raw_column|val|expression][读取列值|固定值|自定义SQL]
"configEventTimeTZColumn":""//事件时区列
"configEventTimeTZ":""//事件时区
"configEventTimeTZLogic":""//事件时区逻辑
//tag
"configEntityColumn":"",//主体列
"configEntityName":"",//分析主体-- 提交分析主体显示名
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"configDateColumn":"",//日期信息列
"tagHistoryVersion":"",//标签日期版本[onlyHistory,onlyLast,historyAndLast]
"configTagDateZoneOffsetVal":"",//标签日期时区
"configDateFormat":"",//日期信息格式
//user
"configDataUpdateTimeColumn":"", //数据更新时间列
//dim
"configEntityIdColumn":""//主体列
"configEntityProp":"",//主体属性
"propType":"",// 主体属性类型
"timeUnitFormat":""// 时间粒度
"configEntityIdColumn":""//主体列
},
"eventMappings": [
{
"routeCodeFromEvent":"",//跨源资产配置名称
"targetEventName":"",//输出事件名
"sourceEventList":"",//原始事件列表
"targetEventDesc":"",//输出事件显示名
"remark":"",//备注
},
],
"propMappings":[
{
"routeCodeFromProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"isPublic":true//是否公共属性
"propConfigRemark":""//备注
}
],
"eventPropMap":[//
{
"routeCodeFromEventPropMap":""//跨源资产配置名称
"eventName":""//输出事件名
"propName":""//输出属性名
}
],
"tagMappings": [
{
"routeCodeFromTag":"",//跨源资产配置名称
"routeResourceKey":"",//原始标签名
"targetTagName":"",//输出标签名
"targetTagDesc":"",//输出标签显示名
"sqlExpression":"",//取值方式
"routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
"extRemark":"",//备注
"extValueZoneOffset":"",//值时区
},
],
"userPropMapping": [
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
}
],
"dimPropMapping":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFormDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
}
]
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| routeConfig | - | Object | 是 | 跨源资产配置信息 |
| routeConfig.routeCode | route_v1 | String | 是 | 跨源资产配置名称 |
| routeConfig.routeDesc | 跨源资产配置 | String | 否 | 跨源资产配置显示名 |
| routeConfig.remark | 跨源资产配置说明 | String | 否 | 配置说明 |
| routeConfig.viewResourceRouteType | event | String | 是 | 资产类型,取值范围为[tag, event, user, dim] |
| routeConfig.modelTable | hive.ta.table_2321 | String | 是 | 数据源 |
| routeConfig.highOrWideEnum | wide | String | 是 | 高宽表,取值范围为[high, wide](事件类型仅支持宽表) |
| (event) | ||||
| routeConfig.configEntityIdColumn | entity_id | String | 否 | 主体列 |
| routeConfig.dataPartTypeEnum | column_date_part | String | 是 | 数据分区方式,取值范围为[column_date_part, auto_push_logic] |
| routeConfig.configDateColumn | #event_time | String | 否 | 日期信息列 (dataPartTypeEnum=column_date_part, 必填) |
| routeConfig.configDateFormat | yyyy-MM-dd | String | 否 | 日期信息格式(dataPartTypeEnum=column_date_part, 必填) |
| routeConfig.configBusinessPushLogic | String | 否 | 下推逻辑 (dataPartTypeEnum=auto_push_logic时,必填) | |
| routeConfig.businessEventNameSelectEnum | raw_column | String | 是 | 事件名取值方式,取值范围为[val, raw_column] |
| routeConfig.configEventName | login | String | 否 | 事件名称 (businessEventNameSelectEnum=val, 必填) |
| routeConfig.configEventNameColumn | #event_name | String | 否 | 事件名称列 (businessEventNameSelectEnum=raw_column, 必填) |
| routeConfig.businessEventDateValueSelectEnum | raw_column | String | 是 | 事件时间取值方式,取值范围为[raw_column, expression] |
| routeConfig.configEventTimeColumn | #event_time | String | 否 | 事件时间列 (businessEventDateValueSelectEnum=raw_column, 必填) |
| routeConfig.configEventTimeLogic | date_parse( "ev_time", '%Y-%m-%d %H:%i:%s' ) | String | 否 | 事件时间逻辑 (businessEventDateValueSelectEnum=expression, 必填) |
| routeConfig.businessEventZoneOffsetSelectEnum | raw_column | String | 是 | 事件时区取值方式,取值范围为[raw_column, val, expression] |
| routeConfig.configEventTimeTZColumn | #zone_offset | String | 否 | 事件时区列 (businessEventZoneOffsetSelectEnum=raw_column, 必填) |
| routeConfig.configEventTimeTZ | 8 | String | 否 | 事件时区 (businessEventZoneOffsetSelectEnum=val, 必填) |
| routeConfig.configEventTimeTZLogic | cast( substr( "zone_offset", 3, 9 ) as double ) | String | 否 | 事件时区逻辑 (businessEventZoneOffsetSelectEnum=expression, 必填) |
| (tag) | ||||
| routeConfig.configEntityColumn | entity_id | String | 是 | 主体列 |
| routeConfig.configEntityName | user_login | String | 是 | 分析主体-- 提交分析主体显示名 |
| routeConfig.configTagNameColumn | tag_name_col | String | 是 | 标签名称列 |
| routeConfig.configTagValueColumn | tag_value_col | String | 是 | 标签值列 |
| routeConfig.tagHistoryVersion | onlyLast | String | 是 | 标签日期版本,取值范围为[onlyHistory,onlyLast,historyAndLast] |
| routeConfig.configDateColumn | #event_time | String | 否 | 日期信息列 (选填) 选择日期分区所在的列, 若日期版本为"仅最新版本"则无需填写 |
| routeConfig.configTagDateZoneOffsetVal | 8 | String | 否 | 标签日期时区 , 日期信息列不为空时必填 |
| routeConfig.configDateFormat | yyyy-MM-dd | String | 否 | 日期信息格式,日期信息列不为空时必填 |
| (user) | ||||
| routeConfig.configDataUpdateTimeColumn | #update_time | String | 否 | 数据更新时间列 |
| (dim) | ||||
| routeConfig.configEntityIdColumn | #id | 否 | 主体列 | |
| routeConfig.configEntityProp | #login | 否 | 主体属性 | |
| routeConfig.propType | userProp | Enum | 否 | 主体属性类型 [userProp, eventProp] |
routeConfig.timeUnitFormat | DATE_STR_YEAR | Enum | 否 | 时间粒度 [DATE_STR_YEAR, DATE_STR_MONTH, DATE_STR_DAY, DATE_STR_HOUR, DATE_STR_MINUTE, DATE_STR_SECOND, DATE_STR_MILLISECOND] |
| - | ||||
| eventMappings | - | Array | - | |
| eventMappings.routeCodeFromEvent | route_v1 | String | 是 | 跨源资产配置名称 |
| eventMappings.targetEventName | login | String | 是 | 输出事件名 |
| eventMappings.sourceEventList | ( 'event_1' , 'event_2' ) | String | 否 | 原始事件列表 |
| eventMappings.targetEventDesc | 登录 | String | 否 | 输出事件显示名 |
| eventMappings.remark | OSS登录 | String | 否 | 备注 |
| - | ||||
| propMappings | - | Array | - | |
| propMappings.routeCodeFromProp | route_v1 | String | 是 | 跨源资产配置名称 |
| propMappings.sourcePropName | account | String | 否 | 原始属性名 |
| propMappings.targetPropName | account | String | 是 | 输出属性名 |
| propMappings.targetPropDesc | 账户 | String | 否 | 输出属性显示名 |
| propMappings.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| propMappings.targetPropTypeEnum | String | String | 是 | 输出属性类型 |
| propMappings.isPublic | true | Boolean | 否 | 是否公共属性 |
| propMappings.propConfigRemark | - | String | 否 | 备注 |
| - | ||||
| eventPropMap | - | Array | - | |
| eventPropMap.routeCodeFromEventPropMap | route_v1 | String | 是 | 跨源资产配置名称 |
| eventPropMap.eventName | - | String | 是 | 输出事件名 |
| eventPropMap.propName | - | String | 是 | 输出属性名 |
| - | ||||
| tagMappings | - | Array | ||
| tagMappings.routeCodeFromTag | route_v1 | String | 是 | 跨源资产配置名称 |
| tagMappings.routeResourceKey | tag_1 | String | 否 | 原始标签名 |
| tagMappings.targetTagName | tag_name | String | 是 | 输出标签名 |
| tagMappings.targetTagDesc | tag_desc | String | 否 | 输出标签显示名 |
| tagMappings.sqlExpression | - | String | 否 | 取值方式 |
| tagMappings.routeSelectTypeEnum | number | String | 是 | 取值范围为[number,string,datetime,bool,array] |
| tagMappings.extRemark | - | String | 否 | 备注 |
| tagMappings.extValueZoneOffset | 8 | String | 否 | 值时区 |
| - | ||||
| userPropMapping | ||||
| userPropMapping.routeCodeFromUserProp | route_v1 | String | 是 | 跨源资产配置名称 |
| userPropMapping.sourcePropName | account | String | 否 | 原始属性名 |
| userPropMapping.targetPropName | account | String | 是 | 输出属性名 |
| userPropMapping.targetPropDesc | 账户 | String | 否 | 输出属性显示名 |
| userPropMapping.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| userPropMapping.targetPropTypeEnum | String | String | 是 | 输出属性类型[] |
| userPropMapping.propConfigRemark | - | String | 否 | 备注 |
| userPropMapping.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
| - | ||||
| dimPropMapping | ||||
| dimPropMapping.routeCodeFromDim | route_v1 | String | 是 | 跨源资产配置名称 |
| dimPropMapping.sourceNameFormDim | account | String | 否 | 原始属性名 |
| dimPropMapping.targetNameFromDim | account | String | 是 | 输出属性名 |
| dimPropMapping.targetDescFromDim | 账户 | String | 否 | 输出属性显示名 |
| dimPropMapping.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| dimPropMapping.targetTypeEnum | String | String | 是 | 输出属性类型[] |
| dimPropMapping.remark | - | String | 否 | 备注 |
| dimPropMapping.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
成功响应示例
{
"return_code": 0,
"return_message": "success"
}
3. 更新资产枚举值
接口URL
/open/route/updateAssetEnumValues?token=xxx&projectId=xxx
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| routeId | 12 | Long | 是 | 跨源配置ID |
| resourceType | TAG | enum | 是 | 输出资产类型[TAG, EVENT_PROP, U_PROP, DIM_PROP] |
| resourceCode | tag_1 | String | 是 | 输出资产名 |
请求Body参数
["t_1","t_2"]
成功响应示例
{
"return_code": 0,
"return_message": "success"
}
4. 资产扫描-提交资产扫描任务
接口URL
/open/route/searchTask/submit
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| isEvent | Boolean | 否 | 跨源配置ID,是否为事件类型,默认为false。仅扫描事件时需要填写isEvent=true |
请求Body参数
{
"routeConfig": {
"viewResourceRouteType":"event",//资产类型[tag,event,user,dim]
"modelTable":"",//数据源,==dataSource
"highOrWideEnum":"",//高宽表[high,wide]
"configTagNameColumn":"",//标签名称列
"configTagValueColumn":"",//标签值列
"businessEventNameSelectEnum":""//事件名取值方式[raw_column]
"configEventNameColumn":""//事件名称列
},
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| viewResourceRouteType | tag | Enum | 是 | 资产类型 [tag, event, user, dim] |
| modelTable | hive.ta.v_event_1 | String | 是 | 数据源 |
| highOrWideEnum | high | Enum | 是 | 高宽表[high,wide](仅tag类型支持high) |
| configTagNameColumn | tag_name_column | String | 否 | 标签名称列 (viewResourceRouteType=tag时必填) |
| configTagValueColumn | tag_value_column | String | 否 | 标签值列(viewResourceRouteType=tag时必填) |
| businessEventNameSelectEnum | raw_column | Enum | 否 | 事件名取值方式[raw_column](viewResourceRouteType=event是必传,固定传raw_column) |
| configEventNameColumn | #event_name | String | 否 | 事件名称列(viewResourceRouteType=event, isEvent=true时必填) |
| configEntityIdColumn | #user_id | String | 否 | 主体列(viewResourceRouteType=dim时必填) |
成功响应示例
{
"data": {
"taskId":"***"
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | Object | |
| data.taskId | String | 扫描任务唯一标识 |
5. 资产扫描-检查资产扫描状态
接口URL
/open/route/searchTask/check
请求方式
GET
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| taskId | xxx | String | 是 | 扫描任务唯一标识 |
成功响应示例
{
"data": {
"state":"error" //running、success、error
"msg":"失败原因" // it is existing when status == error
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | Object | |
| data.state | success | Enum | 扫描状态[running, success, error] |
| data.msg | - | String | 失败原因 |
6. 资产扫描-获取扫描结果
接口URL
/open/route/searchTask/result
请求方式
GET
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| taskId | xxx | String | 是 | 扫描任务唯一标识 |
成功响应示例
//标签
{
//limit 500
"data": [
{
"sourceName":"",//原始标签名
"sourceSelectType":"",//原始标签类型
"targetName":"",//目标资产名
"targetSelectType":""//目标资产类型
}
],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
//事件属性
{
//limit 500
"data": [
{
"sourceName":"",//原始事件属性名
"sourceSelectType":"",//原始事件属性类型
"targetName":"",//目标资产名
"targetSelectType":""//目标资产类型
}
],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
//事件
{
//limit 500
"data": ["","",""],
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
标签&事件属性
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | Object | |
| data.sourceName | tag_1 | String | 原始标签名 |
| data.sourceSelectType | String | String | 原始标签类型 |
| data.targetName | tag_1 | String | 目标资产名 |
| data.targetSelectType | String | String | 目标资产类型 |
事件
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| data | - | Array | 事件名 |
7. 获取跨源配置详情
接口URL
/open/route/get
请求方式
GET
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| id | 10 | Integer | 是 | 配置id |
请求Body参数
{
"data": {
"assetsList": [
"platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
],
"checkStatus": "check_fail",//[un_checked, checking, check_success, check_fail]
"configDesc": {
"tag_value_column": "tag_value_tm",//标签值列
"business_part_date_type": "仅历史版本",//标签日期版本
"entity_column": "#varchar_id",//分析主体列
"tag_zone_offset": "8",//标签日期时区
"tag_entity_name": "用户",//分析主体
"part_date_type": "bigint",//
"part_date_format": "yyyyMMdd",
"tag_name_column": "cluster_name",
"part_date_column": "$tag_date",
"business_data_part_type": "单列日期分区"
"business_event_date_value_select": "expression"
"business_event_name_select": "raw_column"
"business_event_zone_offset_select": "raw_column"
"event_name_column": "event_name_rename"
"event_time_column": "date_parse(\"etime_var1\", '%Y-%m-%d %H:%i:%s.%f')"
"event_time_tz_column": "#zone_offset_raw"
"event_u_entity_column": "cross_aid",
"configDataUpdateTimeColumn": "",
"column_table_type": "eventProp",
"timestamp_join_format": "DATE_STR_YEAR",
"join_key_column": "#time",
"prop_name_column": "#luky_day"
},
"eventResourceMap": {},
"id": 24101,
"modelTable": "hive.ws_lingzhi_product.cross_history_tag2",
"modelTableDesc": "",
"remark": "跨源用户标签 文本 tag_20241219_2",
"resourceType": "tag",
"routeCode": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"routeDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"wideTable": false,
"msgMap":[],
"assetsResourceList": [
{
"checkStatusEnum": "check_fail",//[un_checked, checking, check_success, check_fail]
"checkStatusMsg": "主体列类型与分析主体类型不一致",
"extConfig": {
"remark": "没有显示名的标签",
"valueZoneOffset": "8.0"
},
"id": 457963,
"routeResourceKey": "tag_value_tm",
"sourceTagType": "timestamp",
"sqlExpression":"",
"targetSelectType": "datetime",
"targetTagDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
"targetTagName": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
"enums":[""], // 枚举值样例 limit 10
"lastUpdateEnumTime":"", // 最后更新时间
"enumSize" : 10, // 枚举个数,
}
],
"eventResourceMap": {
"eventPropMappings": [
{
"targetEventName": "activity_attend",
"targetEventPropName": "reward_amount"
}
],
"eventProps": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"extConfig": {
"isPublic": 1,
"remark":""
},
"routeResourceKey": "#account_id",
"sourceEventPropType": "varchar",
"sqlExpression":"",
"targetEventPropDesc": "",
"targetEventPropName": "account_id",
"targetSelectType": "string"
//add props
"enums":[""], // 枚举值样例 limit 10
"lastUpdateEnumTime":"", // 最后更新时间
"enumSize" : 10, // 枚举个数,
}
],
"events": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"sourceUserPropType": "timestamp",
"targetEventDesc": "跨源-参与活动",
"targetEventList": "",
"targetEventName": "activity_attend"
}
]
},
"userResourceList":[
{
"checkStatusEnum": "check_success"
"checkStatusMsg": ""
"routeResourceKey": "cross_aid"
"sqlExpression": "",
"sourceDimPropType":"",
"targetSelectType": "string"
"targetUserPropDesc": "账户ID_cross"
"targetUserPropName": "cross_aid"
}
],
"dimResourceMap": [
{
"checkStatusEnum": "check_success",
"checkStatusMsg": "",
"extConfig": {
"remark": ""
},
"routeResourceKey": "time",
"sqlExpression":"",
"targetSelectType": "datetime",
"targetUserPropDesc": "",
"targetUserPropName": "luky_day@time"
},
]
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| id | 24101 | Integer | 配置ID |
| modelTable | hive.ta.tag2 | String | 数据源 |
| modelTableDesc | tag2_desc | String | 数据源描述 |
| remark | remark | String | 备注 |
| resourceType | tag | String | 资产类型[tag, event] |
| routeCode | route_code | String | 跨源资产配置名称 |
| routeDesc | route_dec | String | 跨源资产配置描述 |
| wideTable | true | boolean | 是否宽表 |
| msgMap | [] | List<String> | 配置检查错误清单 |
| assetsList | [] | List<String> | 资产名清单 |
| checkStatus | check_success | Enum | 检查状态[un_checked, checking, check_success, check_fail] |
| configDesc | - | Object | 配置详情 |
| configDesc.part_date_type | bigint | String | 日期分区类型 |
| configDesc.part_date_format | yyyyMMdd | String | 日期分区格式 |
| configDesc.part_date_column | $part_date | String | 日期分区列 |
| resourceType=tag | |||
| configDesc.tag_value_column | tag_value_tm | String | 标签值列 |
| configDesc.business_part_date_type | 仅历史版本 | String | 标签日期版本 |
| configDesc.entity_column | #varchar_id | String | 分析主体列(resourceType=tag) |
| configDesc.tag_zone_offset | 8 | String | 标签日期时区(resourceType=tag) |
| configDesc.tag_entity_name | 用户 | String | 分析主体(resourceType=tag) |
| configDesc.tag_name_column | cluster_name | String | 标签日期列(resourceType=tag) |
| resourceType=event | |||
| configDesc.business_data_part_type | column_date_part | String | 数据分区方式 |
| configDesc.business_event_date_value_select | expression | String | 事件时间取值方式 |
| configDesc.business_event_name_select | raw_column | String | 事件名取值方式 |
| configDesc.business_event_zone_offset_select | raw_column | String | 事件时区取值方式 |
| configDesc.event_name_column | event_name_rename | String | 事件名列 |
| configDesc.event_time_column | - | String | 事件时间列 |
| configDesc.event_time_tz_column | - | String | 事件时区列 |
| configDesc.event_u_entity_column | - | String | 事件用户实体ID列 |
| configDesc.event_date_column | - | String | 事件日期列 |
| configDesc.event_date_type | - | String | 事件日期数据类型 |
| configDesc.event_date_format | - | String | 事件日期格式 |
| resourceType=user | |||
| configDesc.configDataUpdateTimeColumn | - | String | 数据更新时间列 |
| resourceType=dim | |||
| configDesc.column_table_type | - | String | 主体属性类型 |
| configDesc.timestamp_join_format | - | String | 时间粒度 |
| configDesc.join_key_column | - | String | 主体列 |
| configDesc.prop_name_column | - | String | 主体属性 |
| assetsResourceList | - | Array | 标签资产列表 |
| assetsResourceList.id | 457963 | Integer | 标签映射id |
| assetsResourceList.routeResourceKey | tag_name | String | 原始标签名 |
| assetsResourceList.sourceTagType | String | String | 原始标签类型 |
| assetsResourceList.sqlExpression | - | String | 取值方式 |
| assetsResourceList.targetSelectType | Number | String | 输出标签类型 |
| assetsResourceList.targetTagDesc | 标签 | String | 输出标签显示名 |
| assetsResourceList.targetTagName | tag_a | String | 输出标签名 |
| assetsResourceList.enums | [1,2,3] | Array | 枚举值样例 |
| assetsResourceList.lastUpdateEnumTime | 2024-01-19 | String | 枚举值最后更新时间 |
| assetsResourceList.enumSize | Integer | 枚举个数 | |
| assetsResourceList.checkStatusEnum | check_fail | Enum | 检查状态[un_checked, checking, check_success, check_fail] |
| assetsResourceList.checkStatusMsg | 主体列类型与分析主体类型不一致 | String | 错误信息 |
| assetsResourceList.extConfig | - | Object | 扩展信息 |
| assetsResourceList.extConfig.remark | - | String | 备注 |
| assetsResourceList.extConfig.valueZoneOffset | 8 | String | 标签时区 |
| eventResourceMap | - | Object | 事件资产清单 |
| eventResourceMap.eventPropMappings | - | Array | 事件属性关系 |
| eventResourceMap.eventPropMappings.targetEventName | login | String | 输出事件名 |
| eventResourceMap.eventPropMappings.targetEventPropName | #account_id | String | 输出属性名 |
| eventResourceMap.eventProps | - | Array | 事件属性列表 |
| eventResourceMap.eventProps.routeResourceKey | #account_id | String | 原始属性名 |
| eventResourceMap.eventProps.sourceEventPropType | varchar | String | 原始属性类型 |
| eventResourceMap.eventProps.sqlExpression | - | String | 取值方式 |
| eventResourceMap.eventProps.targetEventPropName | account_id | String | 输出属性名 |
| eventResourceMap.eventProps.targetEventPropDesc | - | String | 输出属性显示名 |
| eventResourceMap.eventProps.targetSelectType | string | String | 输出属性类型 |
| eventResourceMap.eventProps.checkStatusEnum | check_success | Enum | 检查状态 |
| eventResourceMap.eventProps.checkStatusMsg | - | String | 错误信息 |
| eventResourceMap.eventProps.enums | ["1","2"] | Array | 枚举值样例 |
| eventResourceMap.eventProps.lastUpdateEnumTime | 2023-01-12 | String | 最后更新时间 |
| eventResourceMap.eventProps.enumSize | 1203 | Integer | 枚举个数 |
| eventResourceMap.eventProps.extConfig | - | Object | 扩展信息 |
| eventResourceMap.eventProps.extConfig.isPublic | 1 | Integer | 是否为公共属性(1:是,0:否) |
| eventResourceMap.eventProps.extConfig.remark | - | String | 备注 |
| eventResourceMap.events | - | Array | 事件列表 |
| eventResourceMap.events.targetEventDesc | 跨源-参与活动 | String | 输出事件显示名 |
| eventResourceMap.events.targetEventList | - | String | 输出事件列表 |
| eventResourceMap.events.targetEventName | activity_attend | String | 输出事件名 |
| eventResourceMap.events.checkStatusEnum | check_success | Enum | 检查状态 |
| eventResourceMap.events.checkStatusMsg | - | String | 错误信息 |
| userResourceList | - | Array | 实体资产列表 |
| userResourceList.checkStatusEnum | check_success | Enum | 检查状态 |
| userResourceList.checkStatusMsg | - | String | 错误信息 |
| userResourceList.routeResourceKey | #account_id | String | 原始属性名 |
| eventResourceMap.eventProps.sqlExpression | - | String | 取值方式 |
| userResourceList.sourceUserPropType | string | String | 原始属性类型 |
| userResourceList.targetSelectType | string | String | 输出属性类型 |
| userResourceList.targetUserPropDesc | - | String | 输出属性显示名 |
| userResourceList.targetUserPropName | account_id | String | 输出属性名 |
| dimResourceMap | - | Array | 维度资产列表 |
| dimResourceMap.checkStatusEnum | check_success | Enum | 检查状态 |
| dimResourceMap.checkStatusMsg | - | String | 错误信息 |
| dimResourceMap.extConfig.remark | - | String | 备注 |
| dimResourceMap.routeResourceKey | #account_id | String | 原始属性名 |
| dimResourceMap.sqlExpression | - | String | 取值方式 |
| dimResourceMap.sourceDimPropType | - | String | 原始属性类型 |
| dimResourceMap.targetSelectType | string | String | 输出属性类型 |
| dimResourceMap.targetUserPropDesc | - | String | 输出属性显示名 |
| dimResourceMap.targetUserPropName | account_id | String | 输出属性名 |
8. 批量检查路由配置
接口URL
/open/route/checkBatch
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
请求Body参数
//跨源配置id列表
[1, 2]
成功响应示例
{
"return_code": 0,
"return_message": "success"
}
9. 配置增量添加资产
接口URL
/open/route/uploadAsset
请求方式
POST
Content-Type
application/json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
请求Body参数
{
// 路由编码,用于标识要更新的路由配置
"routeCode": "example_route_code",
// 标签映射列表
"tagMappings": [
{
// 跨源资产配置名称
"routeCodeFromTag": "example_route_code",
// 原始标签名
"routeResourceKey": "original_tag_name",
// 输出标签名
"targetTagName": "output_tag_name",
// 输出标签显示名
"targetTagDesc": "输出标签显示名称",
// 取值方式(SQL表达式)
"sqlExpression": "SELECT tag_value FROM tag_table WHERE condition = ?",
// 输出标签类型 [number,string,datetime,bool,array]
"routeSelectTypeEnum": "string",
// 备注
"extRemark": "标签映射备注信息",
// 值时区
"extValueZoneOffset": "+08:00",
// 枚举文件标记
"enumKey": "tag_enum_key",
// 枚举值列表(OpenAPI接口直接传入)
"enumValues": ["value1", "value2", "value3"]
}
],
// 事件映射列表
"eventMappings": [
{
// 跨源资产配置名称
"routeCodeFromEvent": "example_route_code",
// 输出事件名
"targetEventName": "output_event_name",
// 原始事件列表
"sourceEventList": "original_event_list",
// 输出事件显示名
"targetEventDesc": "输出事件显示名称",
// 备注
"remark": "事件映射备注信息"
}
],
// 属性映射列表
"propMappings": [
{
// 跨源资产配置名称
"routeCodeFromProp": "example_route_code",
// 原始属性名
"sourcePropName": "original_prop_name",
// 输出属性名
"targetPropName": "output_prop_name",
// 输出属性显示名
"targetPropDesc": "输出属性显示名称",
// 取值方式(SQL表达式)
"sqlExpressionFromProp": "property_expression",
// 输出属性类型
"targetPropTypeEnum": "string",
// 是否公共属性
"isPublic": true,
// 备注
"propConfigRemark": "属性映射备注信息",
// 枚举文件标记
"enumKey": "prop_enum_key",
// 枚举值列表(OpenAPI接口直接传入)
"enumValues": ["prop_value1", "prop_value2"]
}
],
// 事件属性映射列表
"eventPropMap": [
{
// 跨源资产配置名称
"routeCodeFromEventPropMap": "example_route_code",
// 输出事件名
"eventName": "output_event_name",
// 输出属性名
"propName": "output_prop_name"
}
],
"userPropMappings":[
{
"routeCodeFromUserProp":""//跨源资产配置名称
"sourcePropName":""//原始属性名
"targetPropName":""//输出属性名
"targetPropDesc":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetPropTypeEnum":""//输出属性类型
"propConfigRemark":""//备注
"enumValues":["",]//枚举文件标记
}
],
"dimPropMappings":[ //-> get.eventProps
{
"routeCodeFromDim":""//跨源资产配置名称
"sourceNameFromDim":""//原始属性名
"targetNameFromDim":""//输出属性名
"targetDescFromDim":""//输出属性显示名
"sqlExpressionFromProp":""//取值方式
"targetTypeEnum":""//输出属性类型
"remark":""//备注
"enumValues":["",]//枚举文件标记
}
]
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
| routeCode | example_route_code | String | 是 | 路由编码,用于标识要更新的路由配置 |
| tagMappings | - | Array | 是 | 标签映射列表 |
| tagMappings.routeCodeFromTag | example_route_code | String | 是 | 跨源资产配置名称 |
| tagMappings.routeResourceKey | original_tag_name | String | 否 | 原始标签名 |
| tagMappings.targetTagName | output_tag_name | String | 是 | 输出标签名 |
| tagMappings.targetTagDesc | 输出标签显示名称 | String | 否 | 输出标签显示名 |
| tagMappings.sqlExpression | SELECT tag_value FROM tag_table WHERE condition = ? | String | 否 | 取值方式(SQL表达式) |
| tagMappings.routeSelectTypeEnum | string | String | 是 | 输出标签类型,取值范围为[number,string,datetime,bool,array] |
| tagMappings.extRemark | 标签映射备注信息 | String | 否 | 备注 |
| tagMappings.extValueZoneOffset | 8 | String | 否 | 值时区 |
| tagMappings.enumKey | tag_enum_key | String | 否 | 枚举文件标记 |
| tagMappings.enumValues | ["value1", "value2", "value3"] | List<String> | 否 | 枚举值列表(OpenAPI接口直接传入) |
| eventMappings | - | Array | 是 | 事件映射列表 |
| eventMappings.routeCodeFromEvent | example_route_code | String | 是 | 跨源资产配置名称 |
| eventMappings.targetEventName | output_event_name | String | 是 | 输出事件名 |
| eventMappings.sourceEventList | original_event_list | String | 否 | 原始事件列表 |
| eventMappings.targetEventDesc | 输出事件显示名称 | String | 否 | 输出事件显示名 |
| eventMappings.remark | 事件映射备注信息 | String | 否 | 备注 |
| propMappings | - | Array | 是 | 属性映射列表 |
| propMappings.routeCodeFromProp | example_route_code | String | 是 | 跨源资产配置名称 |
| propMappings.sourcePropName | original_prop_name | String | 否 | 原始属性名 |
| propMappings.targetPropName | output_prop_name | String | 是 | 输出属性名 |
| propMappings.targetPropDesc | 输出属性显示名称 | String | 否 | 输出属性显示名 |
| propMappings.sqlExpressionFromProp | property_expression | String | 否 | 取值方式(SQL表达式) |
| propMappings.targetPropTypeEnum | string | String | 是 | 输出属性类型 |
| propMappings.isPublic | true | Boolean | 否 | 是否公共属性 |
| propMappings.propConfigRemark | 属性映射备注信息 | String | 否 | 备注 |
| propMappings.enumKey | prop_enum_key | String | 否 | 枚举文件标记 |
| propMappings.enumValues | ["prop_value1", "prop_value2"] | List<String> | 否 | 枚举值列表(OpenAPI接口直接传入) |
| eventPropMap | - | Array | 是 | 事件属性映射列表 |
| eventPropMap.routeCodeFromEventPropMap | example_route_code | String | 是 | 跨源资产配置名称 |
| eventPropMap.eventName | output_event_name | String | 是 | 输出事件名 |
| eventPropMap.propName | output_prop_name | String | 是 | 输出属性名 |
| userPropMappings | ||||
| userPropMappings.routeCodeFromUserProp | route_v1 | String | 是 | 跨源资产配置名称 |
| userPropMappings.sourcePropName | account | String | 否 | 原始属性名 |
| userPropMappings.targetPropName | account | String | 是 | 输出属性名 |
| userPropMappings.targetPropDesc | 账户 | String | 否 | 输出属性显示名 |
| userPropMappings.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| userPropMappings.targetPropTypeEnum | String | String | 是 | 输出属性类型[] |
| userPropMappings.propConfigRemark | - | String | 否 | 备注 |
| userPropMappings.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
| dimPropMappings | ||||
| dimPropMappings.routeCodeFromDim | route_v1 | String | 是 | 跨源资产配置名称 |
| dimPropMappings.sourceNameFromDim | account | String | 否 | 原始属性名 |
| dimPropMappings.targetNameFromDim | account | String | 是 | 输出属性名 |
| dimPropMappings.targetDescFromDim | 账户 | String | 否 | 输出属性显示名 |
| dimPropMappings.sqlExpressionFromProp | - | String | 否 | 取值方式 |
| dimPropMappings.targetTypeEnum | String | String | 是 | 输出属性类型[] |
| dimPropMappings.remark | - | String | 否 | 备注 |
| dimPropMappings.enumValues | ["user1","user2"] | List<String> | 否 | 枚举值 |
成功响应示例
{
"data": {
"state": "success",
"msg": []
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
10. 下载枚举值文件
说明:允许同时添加父子属性,不支持子属性或父属性单独添加
PATH:/open/route/downloadEnumFile
Method: GET
requestParam:
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| token | xxx | String | 是 | 查询密钥 |
| projectId | 102 | Integer | 是 | 项目ID |
| routeCode | example_route_code | String | 是 | 路由编码,用于标识要更新的路由配置 |
resourceType | TAG | enum | 是 | 输出资产类型[TAG, EVENT_PROP, U_PROP, DIM_PROP] |
| resourceCode | tag_1 | String | 是 | 输出资产名 |
resopnse:file

