クロスソース構成 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](highはtagタイプのみ対応) |
| 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

