Model mapping configuration API

Last updated 10/05/2026

For how to call the API, see the calling method described in the Open API document.

1. Create a model mapping asset configuration

Creates a model mapping asset configuration.

Endpoint URL

/open/route/createRoute?token=xxx&proejctId=xxx

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID

Request body parameters

代码块

{
    "routeConfig": {
        "routeCode":"",//
        "routeDesc":"",//Model mapping asset configuration display name
        "remark":"",//Description
        "viewResourceRouteType":"event",//Asset type[tag,event,user,dim]
        "modelTable":"",//Data source
        "highOrWideEnum":"",//Tall/wide table[high,wide]
        // event
        "configEntityIdColumn":""//Entity column //event&dim
        "dataPartTypeEnum":""//Data partitioning method[column_date_part|auto_push_logic][Date column|Custom pushdown logic]
        "configDateColumn":""//Date column
        "configDateFormat":""//Date format
        "configBusinessPushLogic":""//Pushdown logic
        "businessEventNameSelectEnum":""//Event name acquisition method[val|raw_column][Constant|Read column value]
        "configEventName":""//Event name
        "configEventNameColumn":""//Event name column
        "businessEventDateValueSelectEnum":""//Event time acquisition method[raw_column|expression][Read column value|Custom SQL]
        "configEventTimeColumn":""//Event time column
        "configEventTimeLogic":""//Event time logic
        "businessEventZoneOffsetSelectEnum":""//Event time zone acquisition method[raw_column|val|expression][Read column value|Constant|Custom SQL]
        "configEventTimeTZColumn":""//Event time zone column
        "configEventTimeTZ":""//Event time zone
        "configEventTimeTZLogic":""//Event time zone logic
        //tag
        "configEntityColumn":"",//Entity column
        "configEntityName":"",//Entity -- submit the entity display name
        "configTagNameColumn":"",//Tag name column
        "configTagValueColumn":"",//Tag value column
        "configDateColumn":"",//Date column
        "tagHistoryVersion":"",//Tag date version[onlyHistory,onlyLast,historyAndLast]
        "configTagDateZoneOffsetVal":"",//Tag date time zone
        "configDateFormat":"",//Date format
        //user
        "configDataUpdateTimeColumn":"", //Data update time column
        //dim
        "configEntityIdColumn":""//Entity column
        "configEntityProp":"",//Entity property
        "propType":"",// Entity property type 
        "timeUnitFormat":""// Time granularity
        
    },
    "eventMappings": [
        {
            "routeCodeFromEvent":"",//Model mapping asset configuration name
            "targetEventName":"",//Output event name 
            "sourceEventList":"",//Original event list 
            "targetEventDesc":"",//Output event display name
            "remark":"",//Remarks
        },
    ],
    "propMappings":[
        {
            "routeCodeFromProp":""//Model mapping asset configuration name
            "sourcePropName":""//Original property name 
            "targetPropName":""//Output property name 
            "targetPropDesc":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method
            "targetPropTypeEnum":""//Output property type [array_string]
            "isPublic":true//Is super property
            "propConfigRemark":""//Remarks
            "enumValues":["",]//Enum file key
           
        }
    ],
    "eventPropMap":[// 
        {
            "routeCodeFromEventPropMap":""//Model mapping asset configuration name
            "eventName":""//Output event name 
            "propName":""//Output property name
        }
    ],
    "tagMappings": [
        {
            "routeCodeFromTag":"",//Model mapping asset configuration name
            "routeResourceKey":"",//Original tag name
            "targetTagName":"",//Output tag name
            "targetTagDesc":"",//Output tag display name
            "sqlExpression":"",//Value acquisition method
            "routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
            "extRemark":"",//Remarks
            "extValueZoneOffset":"",//Value time zone
            "enumValues":["",]//Enum file key
        },
    ],
    "userPropMapping": [
        {
            "routeCodeFromUserProp":""//Model mapping asset configuration name
            "sourcePropName":""//Original property name 
            "targetPropName":""//Output property name 
            "targetPropDesc":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetPropTypeEnum":""//Output property type 
            "propConfigRemark":""//Remarks 
            "enumValues":["",]//Enum file key
        }
    ],
    "dimPropMapping":[ //-> get.eventProps
        {
            "routeCodeFromDim":""//Model mapping asset configuration name
            "sourceNameFromDim":""//Original property name 
            "targetNameFromDim":""//Output property name 
            "targetDescFromDim":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetTypeEnum":""//Output property type 
            "remark":""//Remarks 
            "enumValues":["",]//Enum file key
        }
    ]
}

Parameter name	Example value	Parameter type	Required	Description
routeConfig	-	Object	Yes	Model mapping asset configuration information
routeConfig.routeCode	route_v1	String	Yes	Model mapping asset configuration name (pass user_entity_route when the asset type is user)
routeConfig.routeDesc	Model Mapping Assets Configuration	String	No	Model mapping asset configuration display name
routeConfig.remark	Model mapping asset configuration description	String	No	Description
routeConfig.viewResourceRouteType	event	String	Yes	Asset type. Valid values: [tag, event, user, dim]
routeConfig.modelTable	hive.ta.table_2321	String	Yes	Data Source
routeConfig.highOrWideEnum	wide	String	Yes	Tall or wide table. Valid values: [high, wide] (the event type supports wide tables only)
（event）
routeConfig.configEntityIdColumn	entity_id	String	No	Entity column (routeConfig.viewResourceRouteType=event|dim, required)
routeConfig.dataPartTypeEnum	column_date_part	String	Yes	Data partitioning method. Valid values: [column_date_part, auto_push_logic]
routeConfig.configDateColumn	#event_time	String	No	Date column (dataPartTypeEnum=column_date_part, required)
routeConfig.configDateFormat	yyyy-MM-dd	String	No	Date format (dataPartTypeEnum=column_date_part, required)
routeConfig.configBusinessPushLogic		String	No	Pushdown logic (required when dataPartTypeEnum=auto_push_logic)
routeConfig.businessEventNameSelectEnum	raw_column	String	Yes	Event name acquisition method. Valid values: [val, raw_column]
routeConfig.configEventName	login	String	No	Event name (businessEventNameSelectEnum=val, required)
routeConfig.configEventNameColumn	#event_name	String	No	Event name column (businessEventNameSelectEnum=raw_column, required)
routeConfig.businessEventDateValueSelectEnum	raw_column	String	Yes	Event time acquisition method. Valid values: [raw_column, expression]
routeConfig.configEventTimeColumn	#event_time	String	No	Event time column (businessEventDateValueSelectEnum=raw_column, required)
routeConfig.configEventTimeLogic	date_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )	String	No	Event time logic (businessEventDateValueSelectEnum=expression, required)
routeConfig.businessEventZoneOffsetSelectEnum	raw_column	String	Yes	Event time zone acquisition method. Valid values: [raw_column, val, expression]
routeConfig.configEventTimeTZColumn	#zone_offset	String	No	Event time zone column (businessEventZoneOffsetSelectEnum=raw_column, required)
routeConfig.configEventTimeTZ	8	String	No	Event time zone (businessEventZoneOffsetSelectEnum=val, required)
routeConfig.configEventTimeTZLogic	cast( substr( "zone_offset", 3, 9 ) as double )	String	No	Event time zone logic (businessEventZoneOffsetSelectEnum=expression, required)
（tag）
routeConfig.configEntityColumn	entity_id	String	Yes	Entity column
routeConfig.configEntityName	user_login	String	Yes	Entity -- submit the entity display name
routeConfig.configTagNameColumn	tag_name_col	String	Yes	Tag name column
routeConfig.configTagValueColumn	tag_value_col	String	Yes	Tag value column
routeConfig.tagHistoryVersion	onlyLast	String	Yes	Tag date version. Valid values: [onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn	#event_time	String	No	Date column (optional). Select the column that contains the date partition. Not needed if the date version is "Only current version"
routeConfig.configTagDateZoneOffsetVal	8	String	No	Tag date time zone. Required when the date column is not empty
routeConfig.configDateFormat	yyyy-MM-dd	String	No	Date format. Required when the date column is not empty
(user)
routeConfig.configDataUpdateTimeColumn	#update_time	String	No	Data update time column
（dim）
routeConfig.configEntityIdColumn	#id		No	Entity column
routeConfig.configEntityProp	#login		No	Entity property
routeConfig.propType	userProp	Enum	No	Entity property type [userProp, eventProp]
routeConfig.timeUnitFormat	DATE_STR_YEAR	Enum	No	Time granularity [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	Yes	Model mapping asset configuration name
eventMappings.targetEventName	login	String	Yes	Output event name
eventMappings.sourceEventList	( 'event_1' , 'event_2' )	String	No	Original event list
eventMappings.targetEventDesc	Login	String	No	Output event display name
eventMappings.remark	OSS login	String	No	Remarks
-
propMappings	-	Array		-
propMappings.routeCodeFromProp	route_v1	String	Yes	Model mapping asset configuration name
propMappings.sourcePropName	account	String	No	Original property name
propMappings.targetPropName	account	String	Yes	Output property name
propMappings.targetPropDesc	Account	String	No	Output property display name
propMappings.sqlExpressionFromProp	-	String	No	Value acquisition method
propMappings.targetPropTypeEnum	String	String	Yes	Output property type[]
propMappings.isPublic	true	Boolean	No	Whether it's a super property
propMappings.propConfigRemark	-	String	No	Remarks
propMappings.enumValues	["user1","user2"]	List<String>	No	Enum values
-
eventPropMap	-	Array		-
eventPropMap.routeCodeFromEventPropMap	route_v1	String	Yes	Model mapping asset configuration name
eventPropMap.eventName	-	String	Yes	Output event name
eventPropMap.propName	-	String	Yes	Output property name
-
tagMappings	-	Array
tagMappings.routeCodeFromTag	route_v1	String	Yes	Model mapping asset configuration name
tagMappings.routeResourceKey	tag_1	String	No	Original tag name
tagMappings.targetTagName	tag_name	String	Yes	Output tag name
tagMappings.targetTagDesc	tag_desc	String	No	Output tag display name
tagMappings.sqlExpression	-	String	No	Value acquisition method
tagMappings.routeSelectTypeEnum	number	String	Yes	Valid values: [number,string,datetime,bool,array]
tagMappings.extRemark	-	String	No	Remarks
tagMappings.extValueZoneOffset	8	String	No	Value time zone
tagMappings.enumValues	["t_1","t_2"]	List<String>	No	Enum file key
-
userPropMapping
userPropMapping.routeCodeFromUserProp	route_v1	String	Yes	Model mapping asset configuration name
userPropMapping.sourcePropName	account	String	No	Original property name
userPropMapping.targetPropName	account	String	Yes	Output property name
userPropMapping.targetPropDesc	Account	String	No	Output property display name
userPropMapping.sqlExpressionFromProp	-	String	No	Value acquisition method
userPropMapping.targetPropTypeEnum	String	String	Yes	Output property type[]
userPropMapping.propConfigRemark	-	String	No	Remarks
userPropMapping.enumValues	["user1","user2"]	List<String>	No	Enum values
-
dimPropMapping
dimPropMapping.routeCodeFromDim	route_v1	String	Yes	Model mapping asset configuration name
dimPropMapping.sourceNameFormDim	account	String	No	Original property name
dimPropMapping.targetNameFromDim	account	String	Yes	Output property name
dimPropMapping.targetDescFromDim	Account	String	No	Output property display name
dimPropMapping.sqlExpressionFromProp	-	String	No	Value acquisition method
dimPropMapping.targetTypeEnum	String	String	Yes	Output property type[]
dimPropMapping.remark	-	String	No	Remarks
dimPropMapping.enumValues	["user1","user2"]	List<String>	No	Enum values

Success response example

{
    "return_code": 0,
    "return_message": "success"
}

2. Update a model mapping asset configuration

Endpoint URL

/open/route/updateRoute?token=xxx

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID

Request body parameters

{
    "routeConfig": {
        "routeCode":"",//
        "routeDesc":"",//Model mapping asset configuration display name
        "remark":"",//Description
        "viewResourceRouteType":"event",//Asset type[tag,event,user,dim]
        "modelTable":"",//Data source
        "highOrWideEnum":"",//Tall/wide table[high,wide]
        //event
        "configEntityIdColumn":""//Entity column
        "dataPartTypeEnum":""//Data partitioning method[column_date_part|auto_push_logic][Date column|Custom pushdown logic]
        "configDateColumn":""//Date column
        "configDateFormat":""//Date format
        "configBusinessPushLogic":""//Pushdown logic
        "businessEventNameSelectEnum":""//Event name acquisition method[val|raw_column][Constant|Read column value]
        "configEventName":""//Event name
        "configEventNameColumn":""//Event name column
        "businessEventDateValueSelectEnum":""//Event time acquisition method[raw_column|expression][Read column value|Custom SQL]
        "configEventTimeColumn":""//Event time column
        "configEventTimeLogic":""//Event time logic
        "businessEventZoneOffsetSelectEnum":""//Event time zone acquisition method[raw_column|val|expression][Read column value|Constant|Custom SQL]
        "configEventTimeTZColumn":""//Event time zone column
        "configEventTimeTZ":""//Event time zone
        "configEventTimeTZLogic":""//Event time zone logic
        //tag
         "configEntityColumn":"",//Entity column
        "configEntityName":"",//Entity -- submit the entity display name
        "configTagNameColumn":"",//Tag name column
        "configTagValueColumn":"",//Tag value column
        "configDateColumn":"",//Date column
        "tagHistoryVersion":"",//Tag date version[onlyHistory,onlyLast,historyAndLast]
        "configTagDateZoneOffsetVal":"",//Tag date time zone
        "configDateFormat":"",//Date format
        //user
        "configDataUpdateTimeColumn":"", //Data update time column
        //dim
        "configEntityIdColumn":""//Entity column
        "configEntityProp":"",//Entity property
        "propType":"",// Entity property type 
        "timeUnitFormat":""// Time granularity
        "configEntityIdColumn":""//Entity column
    },
    "eventMappings": [
        {
            "routeCodeFromEvent":"",//Model mapping asset configuration name
            "targetEventName":"",//Output event name 
            "sourceEventList":"",//Original event list 
            "targetEventDesc":"",//Output event display name
            "remark":"",//Remarks
        },
    ],
    "propMappings":[
        {
            "routeCodeFromProp":""//Model mapping asset configuration name
            "sourcePropName":""//Original property name 
            "targetPropName":""//Output property name 
            "targetPropDesc":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method
            "targetPropTypeEnum":""//Output property type
            "isPublic":true//Is super property
            "propConfigRemark":""//Remarks
        }
    ],
    "eventPropMap":[// 
        {
            "routeCodeFromEventPropMap":""//Model mapping asset configuration name
            "eventName":""//Output event name 
            "propName":""//Output property name
        }
    ],
    "tagMappings": [
        {
            "routeCodeFromTag":"",//Model mapping asset configuration name
            "routeResourceKey":"",//Original tag name
            "targetTagName":"",//Output tag name
            "targetTagDesc":"",//Output tag display name
            "sqlExpression":"",//Value acquisition method
            "routeSelectTypeEnum":"",//[number,string,datetime,bool,array]
            "extRemark":"",//Remarks
            "extValueZoneOffset":"",//Value time zone
        },
    ],
    "userPropMapping": [
        {
            "routeCodeFromUserProp":""//Model mapping asset configuration name
            "sourcePropName":""//Original property name 
            "targetPropName":""//Output property name 
            "targetPropDesc":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetPropTypeEnum":""//Output property type 
            "propConfigRemark":""//Remarks 
        }
    ],
    "dimPropMapping":[ //-> get.eventProps
        {
            "routeCodeFromDim":""//Model mapping asset configuration name
            "sourceNameFormDim":""//Original property name 
            "targetNameFromDim":""//Output property name 
            "targetDescFromDim":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetTypeEnum":""//Output property type 
            "remark":""//Remarks 
        }
    ]
}

Parameter name	Example value	Parameter type	Required	Description
routeConfig	-	Object	Yes	Model mapping asset configuration information
routeConfig.routeCode	route_v1	String	Yes	Model mapping asset configuration name
routeConfig.routeDesc	Model Mapping Assets Configuration	String	No	Model mapping asset configuration display name
routeConfig.remark	Model mapping asset configuration description	String	No	Description
routeConfig.viewResourceRouteType	event	String	Yes	Asset type. Valid values: [tag, event, user, dim]
routeConfig.modelTable	hive.ta.table_2321	String	Yes	Data Source
routeConfig.highOrWideEnum	wide	String	Yes	Tall or wide table. Valid values: [high, wide] (the event type supports wide tables only)
（event）
routeConfig.configEntityIdColumn	entity_id	String	No	Entity column
routeConfig.dataPartTypeEnum	column_date_part	String	Yes	Data partitioning method. Valid values: [column_date_part, auto_push_logic]
routeConfig.configDateColumn	#event_time	String	No	Date column (dataPartTypeEnum=column_date_part, required)
routeConfig.configDateFormat	yyyy-MM-dd	String	No	Date format (dataPartTypeEnum=column_date_part, required)
routeConfig.configBusinessPushLogic		String	No	Pushdown logic (required when dataPartTypeEnum=auto_push_logic)
routeConfig.businessEventNameSelectEnum	raw_column	String	Yes	Event name acquisition method. Valid values: [val, raw_column]
routeConfig.configEventName	login	String	No	Event name (businessEventNameSelectEnum=val, required)
routeConfig.configEventNameColumn	#event_name	String	No	Event name column (businessEventNameSelectEnum=raw_column, required)
routeConfig.businessEventDateValueSelectEnum	raw_column	String	Yes	Event time acquisition method. Valid values: [raw_column, expression]
routeConfig.configEventTimeColumn	#event_time	String	No	Event time column (businessEventDateValueSelectEnum=raw_column, required)
routeConfig.configEventTimeLogic	date_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )	String	No	Event time logic (businessEventDateValueSelectEnum=expression, required)
routeConfig.businessEventZoneOffsetSelectEnum	raw_column	String	Yes	Event time zone acquisition method. Valid values: [raw_column, val, expression]
routeConfig.configEventTimeTZColumn	#zone_offset	String	No	Event time zone column (businessEventZoneOffsetSelectEnum=raw_column, required)
routeConfig.configEventTimeTZ	8	String	No	Event time zone (businessEventZoneOffsetSelectEnum=val, required)
routeConfig.configEventTimeTZLogic	cast( substr( "zone_offset", 3, 9 ) as double )	String	No	Event time zone logic (businessEventZoneOffsetSelectEnum=expression, required)
（tag）
routeConfig.configEntityColumn	entity_id	String	Yes	Entity column
routeConfig.configEntityName	user_login	String	Yes	Entity -- submit the entity display name
routeConfig.configTagNameColumn	tag_name_col	String	Yes	Tag name column
routeConfig.configTagValueColumn	tag_value_col	String	Yes	Tag value column
routeConfig.tagHistoryVersion	onlyLast	String	Yes	Tag date version. Valid values: [onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn	#event_time	String	No	Date column (optional). Select the column that contains the date partition. Not needed if the date version is "Only current version"
routeConfig.configTagDateZoneOffsetVal	8	String	No	Tag date time zone. Required when the date column is not empty
routeConfig.configDateFormat	yyyy-MM-dd	String	No	Date format. Required when the date column is not empty
(user)
routeConfig.configDataUpdateTimeColumn	#update_time	String	No	Data update time column
（dim）
routeConfig.configEntityIdColumn	#id		No	Entity column
routeConfig.configEntityProp	#login		No	Entity property
routeConfig.propType	userProp	Enum	No	Entity property type [userProp, eventProp]
routeConfig.timeUnitFormat	DATE_STR_YEAR	Enum	No	Time granularity [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	Yes	Model mapping asset configuration name
eventMappings.targetEventName	login	String	Yes	Output event name
eventMappings.sourceEventList	( 'event_1' , 'event_2' )	String	No	Original event list
eventMappings.targetEventDesc	Login	String	No	Output event display name
eventMappings.remark	OSS login	String	No	Remarks
-
propMappings	-	Array		-
propMappings.routeCodeFromProp	route_v1	String	Yes	Model mapping asset configuration name
propMappings.sourcePropName	account	String	No	Original property name
propMappings.targetPropName	account	String	Yes	Output property name
propMappings.targetPropDesc	Account	String	No	Output property display name
propMappings.sqlExpressionFromProp	-	String	No	Value acquisition method
propMappings.targetPropTypeEnum	String	String	Yes	Output property type
propMappings.isPublic	true	Boolean	No	Whether it's a super property
propMappings.propConfigRemark	-	String	No	Remarks
-
eventPropMap	-	Array		-
eventPropMap.routeCodeFromEventPropMap	route_v1	String	Yes	Model mapping asset configuration name
eventPropMap.eventName	-	String	Yes	Output event name
eventPropMap.propName	-	String	Yes	Output property name
-
tagMappings	-	Array
tagMappings.routeCodeFromTag	route_v1	String	Yes	Model mapping asset configuration name
tagMappings.routeResourceKey	tag_1	String	No	Original tag name
tagMappings.targetTagName	tag_name	String	Yes	Output tag name
tagMappings.targetTagDesc	tag_desc	String	No	Output tag display name
tagMappings.sqlExpression	-	String	No	Value acquisition method
tagMappings.routeSelectTypeEnum	number	String	Yes	Valid values: [number,string,datetime,bool,array]
tagMappings.extRemark	-	String	No	Remarks
tagMappings.extValueZoneOffset	8	String	No	Value time zone
-
userPropMapping
userPropMapping.routeCodeFromUserProp	route_v1	String	Yes	Model mapping asset configuration name
userPropMapping.sourcePropName	account	String	No	Original property name
userPropMapping.targetPropName	account	String	Yes	Output property name
userPropMapping.targetPropDesc	Account	String	No	Output property display name
userPropMapping.sqlExpressionFromProp	-	String	No	Value acquisition method
userPropMapping.targetPropTypeEnum	String	String	Yes	Output property type[]
userPropMapping.propConfigRemark	-	String	No	Remarks
userPropMapping.enumValues	["user1","user2"]	List<String>	No	Enum values
-
dimPropMapping
dimPropMapping.routeCodeFromDim	route_v1	String	Yes	Model mapping asset configuration name
dimPropMapping.sourceNameFormDim	account	String	No	Original property name
dimPropMapping.targetNameFromDim	account	String	Yes	Output property name
dimPropMapping.targetDescFromDim	Account	String	No	Output property display name
dimPropMapping.sqlExpressionFromProp	-	String	No	Value acquisition method
dimPropMapping.targetTypeEnum	String	String	Yes	Output property type[]
dimPropMapping.remark	-	String	No	Remarks
dimPropMapping.enumValues	["user1","user2"]	List<String>	No	Enum values

Success response example

{
    "return_code": 0,
    "return_message": "success"
}

3. Update asset enum values

Endpoint URL

/open/route/updateAssetEnumValues?token=xxx&projectId=xxx

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
routeId	12	Long	Yes	Model mapping configuration ID
resourceType	TAG	enum	Yes	Output asset type[TAG, EVENT_PROP, U_PROP, DIM_PROP]
resourceCode	tag_1	String	Yes	Output asset name

Request body parameters

["t_1","t_2"]

Success response example

{
    "return_code": 0,
    "return_message": "success"
}

4. Asset scan - Submit an asset scan task

Endpoint URL

/open/route/searchTask/submit

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
isEvent		Boolean	No	Model mapping configuration ID, and whether it's the event type (false by default). Set isEvent=true only when you scan events

Request body parameters

 {
   "routeConfig": {
        "viewResourceRouteType":"event",//Asset type[tag,event,user,dim] 
        "modelTable":"",//Data source, ==dataSource
        "highOrWideEnum":"",//Tall/wide table[high,wide]
        "configTagNameColumn":"",//Tag name column
        "configTagValueColumn":"",//Tag value column
        "businessEventNameSelectEnum":""//Event name acquisition method[raw_column]
        "configEventNameColumn":""//Event name column
    },
}

Parameter name	Example value	Parameter type	Required	Description
viewResourceRouteType	tag	Enum	Yes	Asset type [tag, event, user, dim]
modelTable	hive.ta.v_event_1	String	Yes	Data Source
highOrWideEnum	high	Enum	Yes	Tall/wide table[high,wide] (only the tag type supports high)
configTagNameColumn	tag_name_column	String	No	Tag name column (required when viewResourceRouteType=tag)
configTagValueColumn	tag_value_column	String	No	Tag value column (required when viewResourceRouteType=tag)
businessEventNameSelectEnum	raw_column	Enum	No	Event name acquisition method[raw_column] (required when viewResourceRouteType=event; always pass raw_column)
configEventNameColumn	#event_name	String	No	Event name column (required when viewResourceRouteType=event and isEvent=true)
configEntityIdColumn	#user_id	String	No	Entity column (required when viewResourceRouteType=dim)

Success response example

{
   "data": {
       "taskId":"***"
   },
   "return_code": 0,
   "return_message": "success",
   "showStackMessage": false
}

Parameter name	Example value	Parameter type	Description
data	-	Object
data.taskId		String	Unique ID of the scan task

5. Asset scan - Check the asset scan status

Endpoint URL

/open/route/searchTask/check

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
taskId	xxx	String	Yes	Unique ID of the scan task

Success response example

{
   "data": {
       "state":"error" //running, success, error
       "msg":"Failure reason" // it is existing when status == error 
   },
   "return_code": 0,
   "return_message": "success",
   "showStackMessage": false
}

Parameter name	Example value	Parameter type	Description
data	-	Object
data.state	success	Enum	Scan status[running, success, error]
data.msg	-	String	Failure reason

6. Asset scan - Get the scan results

Endpoint URL

/open/route/searchTask/result

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
taskId	xxx	String	Yes	Unique ID of the scan task

Success response example

//Tags
{
    //limit 500
   "data": [
       {
           "sourceName":"",//Original tag name
           "sourceSelectType":"",//Original tag type
           "targetName":"",//Target asset name
           "targetSelectType":""//Target asset type
       }
   ],
   "return_code": 0,
   "return_message": "success",
   "showStackMessage": false
}
//Event properties
{
    //limit 500
   "data": [
       {
           "sourceName":"",//Original event property name
           "sourceSelectType":"",//Original event property type
           "targetName":"",//Target asset name
           "targetSelectType":""//Target asset type
       }
   ],
   "return_code": 0,
   "return_message": "success",
   "showStackMessage": false
}
//Events
{
    //limit 500
   "data": ["","",""],
   "return_code": 0,
   "return_message": "success",
   "showStackMessage": false
}

Tags & event properties

Parameter name	Example value	Parameter type	Description
data	-	Object
data.sourceName	tag_1	String	Original tag name
data.sourceSelectType	String	String	Original tag type
data.targetName	tag_1	String	Target asset name
data.targetSelectType	String	String	Target asset type

Events

Parameter name	Example value	Parameter type	Description
data	-	Array	Event name

7. Get model mapping configuration details

Endpoint URL

/open/route/get

Request method

GET

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
id	10	Integer	Yes	Configuration ID

Request body parameters

{
    "data": {
        "assetsList": [
            "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
        ],
        "checkStatus": "check_fail",//[un_checked, checking, check_success, check_fail]
        "configDesc": {
            "tag_value_column": "tag_value_tm",//Tag value column
            "business_part_date_type": "Only historical version",//Tag date version
            "entity_column": "#varchar_id",//Entity column
            "tag_zone_offset": "8",//Tag date time zone
            "tag_entity_name": "User",//Entity
            "part_date_type": "bigint",//
            "part_date_format": "yyyyMMdd",
            "tag_name_column": "cluster_name",
            "part_date_column": "$tag_date",
            "business_data_part_type": "Single column date partition"
            "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": "Model mapping user tag string tag_20241219_2",
        "resourceType": "tag",
        "routeCode": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
        "routeDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
        "wideTable": false,
        "msgMap":[],
        "assetsResourceList": [
            {
                "checkStatusEnum": "check_fail",//[un_checked, checking, check_success, check_fail]
                "checkStatusMsg": "Entity column type doesn't match the entity type",
                "extConfig": {
                    "remark": "Tag without a display name",
                    "valueZoneOffset": "8.0"
                },
                "id": 457963,
                "routeResourceKey": "tag_value_tm",
                "sourceTagType": "timestamp",
                "sqlExpression":"",
                "targetSelectType": "datetime",
                "targetTagDesc": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor",
                "targetTagName": "platformoutobjplatformoutobjplatformoutobjplatformoutobjplatformoutobjplatfor"
                "enums":[""], // Enum value examples limit 10 
                "lastUpdateEnumTime":"", // Last updated
                "enumSize" : 10, // Number of enum values,
            }
        ],
        "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":[""], // Enum value examples limit 10 
                    "lastUpdateEnumTime":"", // Last updated
                    "enumSize" : 10, // Number of enum values,
                }
            ],
            "events": [
                {
                    "checkStatusEnum": "check_success",
                    "checkStatusMsg": "",
                    "sourceUserPropType": "timestamp",
                    "targetEventDesc": "Model mapping - Join Event",
                    "targetEventList": "",
                    "targetEventName": "activity_attend"
                }
            ]
        },
        "userResourceList":[
            {
                "checkStatusEnum": "check_success"
                "checkStatusMsg": ""
                "routeResourceKey": "cross_aid"
                "sqlExpression": "",
                "sourceDimPropType":"",
                "targetSelectType": "string"
                "targetUserPropDesc": "Account 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
}

Parameter name	Example value	Parameter type	Description
id	24101	Integer	Configuration ID
modelTable	hive.ta.tag2	String	Data Source
modelTableDesc	tag2_desc	String	Data source description
remark	remark	String	Remarks
resourceType	tag	String	Asset type[tag, event]
routeCode	route_code	String	Model mapping asset configuration name
routeDesc	route_dec	String	Model mapping asset configuration description
wideTable	true	boolean	Whether it's a wide table
msgMap	[]	List<String>	List of configuration check errors
assetsList	[]	List<String>	List of asset names
checkStatus	check_success	Enum	Check status[un_checked, checking, check_success, check_fail]
configDesc	-	Object	Configuration Details
configDesc.part_date_type	bigint	String	Date partition type
configDesc.part_date_format	yyyyMMdd	String	Date partition format
configDesc.part_date_column	$part_date	String	Date partition column
resourceType=tag
configDesc.tag_value_column	tag_value_tm	String	Tag value column
configDesc.business_part_date_type	Only historical version	String	Tag date version
configDesc.entity_column	#varchar_id	String	Entity column (resourceType=tag)
configDesc.tag_zone_offset	8	String	Tag date time zone (resourceType=tag)
configDesc.tag_entity_name	User	String	Entity (resourceType=tag)
configDesc.tag_name_column	cluster_name	String	Tag date column (resourceType=tag)
resourceType=event
configDesc.business_data_part_type	column_date_part	String	Data partitioning method
configDesc.business_event_date_value_select	expression	String	Event time acquisition method
configDesc.business_event_name_select	raw_column	String	Event name acquisition method
configDesc.business_event_zone_offset_select	raw_column	String	Event time zone acquisition method
configDesc.event_name_column	event_name_rename	String	Event name column
configDesc.event_time_column	-	String	Event time column
configDesc.event_time_tz_column	-	String	Event time zone column
configDesc.event_u_entity_column	-	String	Event user entity ID column
configDesc.event_date_column	-	String	Event date column
configDesc.event_date_type	-	String	Event date data type
configDesc.event_date_format	-	String	Event date format
resourceType=user
configDesc.configDataUpdateTimeColumn	-	String	Data update time column
resourceType=dim
configDesc.column_table_type	-	String	Entity property type
configDesc.timestamp_join_format	-	String	Time granularity
configDesc.join_key_column	-	String	Entity column
configDesc.prop_name_column	-	String	Entity property
assetsResourceList	-	Array	Tag asset list
assetsResourceList.id	457963	Integer	Tag mapping ID
assetsResourceList.routeResourceKey	tag_name	String	Original tag name
assetsResourceList.sourceTagType	String	String	Original tag type
assetsResourceList.sqlExpression	-	String	Value acquisition method
assetsResourceList.targetSelectType	Number	String	Output tag type
assetsResourceList.targetTagDesc	Tags	String	Output tag display name
assetsResourceList.targetTagName	tag_a	String	Output tag name
assetsResourceList.enums	[1,2,3]	Array	Enum value examples
assetsResourceList.lastUpdateEnumTime	2024-01-19	String	Last update time of enum values
assetsResourceList.enumSize		Integer	Number of enum values
assetsResourceList.checkStatusEnum	check_fail	Enum	Check status[un_checked, checking, check_success, check_fail]
assetsResourceList.checkStatusMsg	Entity column type doesn't match the entity type	String	Error message
assetsResourceList.extConfig	-	Object	Extended information
assetsResourceList.extConfig.remark	-	String	Remarks
assetsResourceList.extConfig.valueZoneOffset	8	String	Tag time zone
eventResourceMap	-	Object	Event asset list
eventResourceMap.eventPropMappings	-	Array	Event-property relationships
eventResourceMap.eventPropMappings.targetEventName	login	String	Output event name
eventResourceMap.eventPropMappings.targetEventPropName	#account_id	String	Output property name
eventResourceMap.eventProps	-	Array	Event property list
eventResourceMap.eventProps.routeResourceKey	#account_id	String	Original property name
eventResourceMap.eventProps.sourceEventPropType	varchar	String	Original property type
eventResourceMap.eventProps.sqlExpression	-	String	Value acquisition method
eventResourceMap.eventProps.targetEventPropName	account_id	String	Output property name
eventResourceMap.eventProps.targetEventPropDesc	-	String	Output property display name
eventResourceMap.eventProps.targetSelectType	string	String	Output property type
eventResourceMap.eventProps.checkStatusEnum	check_success	Enum	Check status
eventResourceMap.eventProps.checkStatusMsg	-	String	Error message
eventResourceMap.eventProps.enums	["1","2"]	Array	Enum value examples
eventResourceMap.eventProps.lastUpdateEnumTime	2023-01-12	String	Last updated
eventResourceMap.eventProps.enumSize	1203	Integer	Number of enum values
eventResourceMap.eventProps.extConfig	-	Object	Extended information
eventResourceMap.eventProps.extConfig.isPublic	1	Integer	Whether it's a super property (1: yes, 0: no)
eventResourceMap.eventProps.extConfig.remark	-	String	Remarks
eventResourceMap.events	-	Array	Event list
eventResourceMap.events.targetEventDesc	Model mapping - Event attendance	String	Output event display name
eventResourceMap.events.targetEventList	-	String	Output event list
eventResourceMap.events.targetEventName	activity_attend	String	Output event name
eventResourceMap.events.checkStatusEnum	check_success	Enum	Check status
eventResourceMap.events.checkStatusMsg	-	String	Error message
userResourceList	-	Array	Entity asset list
userResourceList.checkStatusEnum	check_success	Enum	Check status
userResourceList.checkStatusMsg	-	String	Error message
userResourceList.routeResourceKey	#account_id	String	Original property name
eventResourceMap.eventProps.sqlExpression	-	String	Value acquisition method
userResourceList.sourceUserPropType	string	String	Original property type
userResourceList.targetSelectType	string	String	Output property type
userResourceList.targetUserPropDesc	-	String	Output property display name
userResourceList.targetUserPropName	account_id	String	Output property name
dimResourceMap	-	Array	Dimension asset list
dimResourceMap.checkStatusEnum	check_success	Enum	Check status
dimResourceMap.checkStatusMsg	-	String	Error message
dimResourceMap.extConfig.remark	-	String	Remarks
dimResourceMap.routeResourceKey	#account_id	String	Original property name
dimResourceMap.sqlExpression	-	String	Value acquisition method
dimResourceMap.sourceDimPropType	-	String	Original property type
dimResourceMap.targetSelectType	string	String	Output property type
dimResourceMap.targetUserPropDesc	-	String	Output property display name
dimResourceMap.targetUserPropName	account_id	String	Output property name

8. Batch check route configurations

Endpoint URL

/open/route/checkBatch

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID

Request body parameters

//List of model mapping configuration IDs
[1, 2]

Success response example

{
    "return_code": 0,
    "return_message": "success"
}

9. Incrementally add assets to a configuration

Endpoint URL

/open/route/uploadAsset

Request method

POST

Content-Type

application/json

Request query parameters

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID

Request body parameters

{
  // Route code, which identifies the route configuration to update
  "routeCode": "example_route_code",
  
  // Tag mapping list
  "tagMappings": [
    {
      // Model mapping asset configuration name
      "routeCodeFromTag": "example_route_code",
      // Original tag name
      "routeResourceKey": "original_tag_name",
      // Output tag name
      "targetTagName": "output_tag_name",
      // Output tag display name
      "targetTagDesc": "Output tag display name",
      // Value acquisition method (SQL expression)
      "sqlExpression": "SELECT tag_value FROM tag_table WHERE condition = ?",
      // Output tag type [number,string,datetime,bool,array]
      "routeSelectTypeEnum": "string",
      // Remarks
      "extRemark": "Tag mapping remarks",
      // Value time zone
      "extValueZoneOffset": "+08:00",
      // Enum file key
      "enumKey": "tag_enum_key",
      // Enum value list (passed in directly through the OpenAPI)
      "enumValues": ["value1", "value2", "value3"]
    }
  ],
  
  // Event mapping list
  "eventMappings": [
    {
      // Model mapping asset configuration name
      "routeCodeFromEvent": "example_route_code",
      // Output event name
      "targetEventName": "output_event_name",
      // Original event list
      "sourceEventList": "original_event_list",
      // Output event display name
      "targetEventDesc": "Output event display name",
      // Remarks
      "remark": "Event mapping remarks"
    }
  ],
  
  // Property mapping list
  "propMappings": [
    {
      // Model mapping asset configuration name
      "routeCodeFromProp": "example_route_code",
      // Original property name
      "sourcePropName": "original_prop_name",
      // Output property name
      "targetPropName": "output_prop_name",
      // Output property display name
      "targetPropDesc": "Output property display name",
      // Value acquisition method (SQL expression)
      "sqlExpressionFromProp": "property_expression",
      // Output property type
      "targetPropTypeEnum": "string",
      // Is super property
      "isPublic": true,
      // Remarks
      "propConfigRemark": "Property mapping remarks",
      // Enum file key
      "enumKey": "prop_enum_key",
      // Enum value list (passed in directly through the OpenAPI)
      "enumValues": ["prop_value1", "prop_value2"]
    }
  ],
  
  // Event property mapping list
  "eventPropMap": [
    {
      // Model mapping asset configuration name
      "routeCodeFromEventPropMap": "example_route_code",
      // Output event name
      "eventName": "output_event_name",
      // Output property name
      "propName": "output_prop_name"
    }
  ],
  "userPropMappings":[
      {
            "routeCodeFromUserProp":""//Model mapping asset configuration name
            "sourcePropName":""//Original property name 
            "targetPropName":""//Output property name 
            "targetPropDesc":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetPropTypeEnum":""//Output property type 
            "propConfigRemark":""//Remarks 
            "enumValues":["",]//Enum file key
        }
  ],
  "dimPropMappings":[ //-> get.eventProps
        {
            "routeCodeFromDim":""//Model mapping asset configuration name
            "sourceNameFromDim":""//Original property name 
            "targetNameFromDim":""//Output property name 
            "targetDescFromDim":""//Output property display name 
            "sqlExpressionFromProp":""//Value acquisition method 
            "targetTypeEnum":""//Output property type 
            "remark":""//Remarks 
            "enumValues":["",]//Enum file key
        }
    ]
}

Parameter name	Example value	Parameter type	Required	Description
routeCode	example_route_code	String	Yes	Route code, which identifies the route configuration to update
tagMappings	-	Array	Yes	Tag mapping list
tagMappings.routeCodeFromTag	example_route_code	String	Yes	Model mapping asset configuration name
tagMappings.routeResourceKey	original_tag_name	String	No	Original tag name
tagMappings.targetTagName	output_tag_name	String	Yes	Output tag name
tagMappings.targetTagDesc	Output tag display name	String	No	Output tag display name
tagMappings.sqlExpression	SELECT tag_value FROM tag_table WHERE condition = ?	String	No	Value acquisition method (SQL expression)
tagMappings.routeSelectTypeEnum	string	String	Yes	Output tag type. Valid values: [number,string,datetime,bool,array]
tagMappings.extRemark	Tag mapping remarks	String	No	Remarks
tagMappings.extValueZoneOffset	8	String	No	Value time zone
tagMappings.enumKey	tag_enum_key	String	No	Enum file key
tagMappings.enumValues	["value1", "value2", "value3"]	List<String>	No	Enum value list (passed in directly through the OpenAPI)
eventMappings	-	Array	Yes	Event mapping list
eventMappings.routeCodeFromEvent	example_route_code	String	Yes	Model mapping asset configuration name
eventMappings.targetEventName	output_event_name	String	Yes	Output event name
eventMappings.sourceEventList	original_event_list	String	No	Original event list
eventMappings.targetEventDesc	Output event display name	String	No	Output event display name
eventMappings.remark	Event mapping remarks	String	No	Remarks
propMappings	-	Array	Yes	Property mapping list
propMappings.routeCodeFromProp	example_route_code	String	Yes	Model mapping asset configuration name
propMappings.sourcePropName	original_prop_name	String	No	Original property name
propMappings.targetPropName	output_prop_name	String	Yes	Output property name
propMappings.targetPropDesc	Output property display name	String	No	Output property display name
propMappings.sqlExpressionFromProp	property_expression	String	No	Value acquisition method (SQL expression)
propMappings.targetPropTypeEnum	string	String	Yes	Output property type
propMappings.isPublic	true	Boolean	No	Whether it's a super property
propMappings.propConfigRemark	Property mapping remarks	String	No	Remarks
propMappings.enumKey	prop_enum_key	String	No	Enum file key
propMappings.enumValues	["prop_value1", "prop_value2"]	List<String>	No	Enum value list (passed in directly through the OpenAPI)
eventPropMap	-	Array	Yes	Event property mapping list
eventPropMap.routeCodeFromEventPropMap	example_route_code	String	Yes	Model mapping asset configuration name
eventPropMap.eventName	output_event_name	String	Yes	Output event name
eventPropMap.propName	output_prop_name	String	Yes	Output property name
userPropMappings
userPropMappings.routeCodeFromUserProp	route_v1	String	Yes	Model mapping asset configuration name
userPropMappings.sourcePropName	account	String	No	Original property name
userPropMappings.targetPropName	account	String	Yes	Output property name
userPropMappings.targetPropDesc	Account	String	No	Output property display name
userPropMappings.sqlExpressionFromProp	-	String	No	Value acquisition method
userPropMappings.targetPropTypeEnum	String	String	Yes	Output property type[]
userPropMappings.propConfigRemark	-	String	No	Remarks
userPropMappings.enumValues	["user1","user2"]	List<String>	No	Enum values
dimPropMappings
dimPropMappings.routeCodeFromDim	route_v1	String	Yes	Model mapping asset configuration name
dimPropMappings.sourceNameFromDim	account	String	No	Original property name
dimPropMappings.targetNameFromDim	account	String	Yes	Output property name
dimPropMappings.targetDescFromDim	Account	String	No	Output property display name
dimPropMappings.sqlExpressionFromProp	-	String	No	Value acquisition method
dimPropMappings.targetTypeEnum	String	String	Yes	Output property type[]
dimPropMappings.remark	-	String	No	Remarks
dimPropMappings.enumValues	["user1","user2"]	List<String>	No	Enum values

Success response example

{
    "data": {
        "state": "success",
        "msg": []
    },
    "return_code": 0,
    "return_message": "success",
    "showStackMessage": false
}

10. Download the enum value file

Note: Parent and child properties can be added together. Adding only a child property or only a parent property isn't supported

PATH：/open/route/downloadEnumFile

Method: GET

requestParam:

Parameter name	Example value	Parameter type	Required	Description
token	xxx	String	Yes	Query key
projectId	102	Integer	Yes	Project ID
routeCode	example_route_code	String	Yes	Route code, which identifies the route configuration to update
resourceType	TAG	enum	Yes	Output asset type[TAG, EVENT_PROP, U_PROP, DIM_PROP]
resourceCode	tag_1	String	Yes	Output asset name

resopnse:file