メインコンテンツまでスキップ

クロスソース構成 API

最終更新 2026/10/05

呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。

1. クロスソースアセット構成の作成​

クロスソースアセット構成を作成します。

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102Integerはいプロジェクト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.routeCoderoute_v1Stringはいクロスソースアセット構成名(アセットタイプがuserの場合はuser_entity_routeを渡す)
routeConfig.routeDescクロスソースアセット構成Stringいいえクロスソースアセット構成の表示名
routeConfig.remarkクロスソースアセット構成の説明Stringいいえ構成の説明
routeConfig.viewResourceRouteTypeeventStringはいアセットタイプ。値の範囲は[tag, event, user, dim]
routeConfig.modelTablehive.ta.table_2321Stringはいデータソース
routeConfig.highOrWideEnumwideStringはいロング/ワイドテーブル。値の範囲は[high, wide](イベントタイプはワイドテーブルのみ対応)
(event)
routeConfig.configEntityIdColumnentity_idStringいいえ主体列 (routeConfig.viewResourceRouteType=event|dimの場合は必須)
routeConfig.dataPartTypeEnumcolumn_date_partStringはいデータパーティショニング方式。値の範囲は[column_date_part, auto_push_logic]
routeConfig.configDateColumn#event_timeStringいいえ日付情報列 (dataPartTypeEnum=column_date_partの場合は必須)
routeConfig.configDateFormatyyyy-MM-ddStringいいえ日付情報のフォーマット(dataPartTypeEnum=column_date_partの場合は必須)
routeConfig.configBusinessPushLogicStringいいえプッシュダウンロジック (dataPartTypeEnum=auto_push_logicの場合は必須)
routeConfig.businessEventNameSelectEnumraw_columnStringはいイベント名の取得方法。値の範囲は[val, raw_column]
routeConfig.configEventNameloginStringいいえイベント名 (businessEventNameSelectEnum=valの場合は必須)
routeConfig.configEventNameColumn#event_nameStringいいえイベント名列 (businessEventNameSelectEnum=raw_columnの場合は必須)
routeConfig.businessEventDateValueSelectEnumraw_columnStringはいイベント時間の取得方法。値の範囲は[raw_column, expression]
routeConfig.configEventTimeColumn#event_timeStringいいえイベント時間列 (businessEventDateValueSelectEnum=raw_columnの場合は必須)
routeConfig.configEventTimeLogicdate_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )Stringいいえ

イベント時間ロジック (businessEventDateValueSelectEnum=expressionの場合は必須)

routeConfig.businessEventZoneOffsetSelectEnumraw_columnStringはい

イベントタイムゾーンの取得方法。値の範囲は[raw_column, val, expression]

routeConfig.configEventTimeTZColumn#zone_offsetStringいいえイベントタイムゾーン列 (businessEventZoneOffsetSelectEnum=raw_columnの場合は必須)
routeConfig.configEventTimeTZ8Stringいいえイベントタイムゾーン (businessEventZoneOffsetSelectEnum=valの場合は必須)
routeConfig.configEventTimeTZLogiccast( substr( "zone_offset", 3, 9 ) as double )Stringいいえイベントのタイムゾーンロジック (businessEventZoneOffsetSelectEnum=expressionの場合は必須)
(tag)
routeConfig.configEntityColumnentity_idStringはい主体列
routeConfig.configEntityNameuser_loginStringはい分析主体-- 送信する分析主体の表示名
routeConfig.configTagNameColumntag_name_colStringはいタグ名列
routeConfig.configTagValueColumntag_value_colStringはいタグ値列

routeConfig.tagHistoryVersion

onlyLastString

はい

タグ日付バージョン。値の範囲は[onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn#event_timeString

いいえ

日付情報列 (任意) 日付パーティションがある列を選択します。日付バージョンが「最新バージョンのみ」の場合は入力不要です
routeConfig.configTagDateZoneOffsetVal

8

String

いいえ

タグ日付タイムゾーン。日付情報列が空でない場合は必須

routeConfig.configDateFormatyyyy-MM-ddStringいいえ日付情報のフォーマット。日付情報列が空でない場合は必須
(user)
routeConfig.configDataUpdateTimeColumn#update_timeStringいいえデータ更新日時カラム
(dim)
routeConfig.configEntityIdColumn#idいいえ主体列
routeConfig.configEntityProp#loginいいえ主体プロパティ
routeConfig.propTypeuserPropEnumいいえ主体プロパティタイプ [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.routeCodeFromEventroute_v1Stringはいクロスソースアセット構成名
eventMappings.targetEventNameloginStringはい出力されたイベント名
eventMappings.sourceEventList( 'event_1' , 'event_2' )Stringいいえオリジナルイベント一覧
eventMappings.targetEventDescログインStringいいえ出力されたイベントの表示名
eventMappings.remarkOSSログインStringいいえ備考
-
propMappings-Array-
propMappings.routeCodeFromProproute_v1Stringはいクロスソースアセット構成名
propMappings.sourcePropNameaccountStringいいえ元のプロパティ名
propMappings.targetPropNameaccountStringはい出力プロパティ名
propMappings.targetPropDescアカウントStringいいえ出力プロパティの表示名
propMappings.sqlExpressionFromProp-Stringいいえ値の取得方式
propMappings.targetPropTypeEnumStringStringはい出力プロパティのタイプ[]
propMappings.isPublictrueBooleanいいえ共通イベントプロパティかどうか
propMappings.propConfigRemark-Stringいいえ備考
propMappings.enumValues["user1","user2"]List<String>いいえ列挙値
-
eventPropMap-Array-
eventPropMap.routeCodeFromEventPropMaproute_v1Stringはいクロスソースアセット構成名
eventPropMap.eventName-Stringはい出力されたイベント名
eventPropMap.propName-Stringはい出力プロパティ名
-
tagMappings-Array
tagMappings.routeCodeFromTagroute_v1Stringはいクロスソースアセット構成名
tagMappings.routeResourceKeytag_1Stringいいえ元のタグ名
tagMappings.targetTagNametag_nameStringはい出力タグ名
tagMappings.targetTagDesctag_descStringいいえ出力タグ表示名
tagMappings.sqlExpression-Stringいいえ値の取得方式
tagMappings.routeSelectTypeEnumnumberStringはい値の範囲は[number,string,datetime,bool,array]
tagMappings.extRemark-Stringいいえ備考
tagMappings.extValueZoneOffset8Stringいいえ値のタイムゾーン
tagMappings.enumValues["t_1","t_2"]List<String>いいえ列挙ファイルマーカー
-
userPropMapping
userPropMapping.routeCodeFromUserProproute_v1Stringはいクロスソースアセット構成名
userPropMapping.sourcePropNameaccountStringいいえ元のプロパティ名
userPropMapping.targetPropNameaccountStringはい出力プロパティ名
userPropMapping.targetPropDescアカウントStringいいえ出力プロパティの表示名
userPropMapping.sqlExpressionFromProp-Stringいいえ値の取得方式
userPropMapping.targetPropTypeEnumStringStringはい出力プロパティのタイプ[]
userPropMapping.propConfigRemark-Stringいいえ備考
userPropMapping.enumValues["user1","user2"]List<String>いいえ列挙値
-
dimPropMapping
dimPropMapping.routeCodeFromDimroute_v1Stringはいクロスソースアセット構成名
dimPropMapping.sourceNameFormDimaccountStringいいえ元のプロパティ名
dimPropMapping.targetNameFromDimaccountStringはい出力プロパティ名
dimPropMapping.targetDescFromDimアカウントStringいいえ出力プロパティの表示名
dimPropMapping.sqlExpressionFromProp-Stringいいえ値の取得方式
dimPropMapping.targetTypeEnumStringStringはい出力プロパティのタイプ[]
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パラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102Integerはいプロジェクト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.routeCoderoute_v1Stringはいクロスソースアセット構成名
routeConfig.routeDescクロスソースアセット構成Stringいいえクロスソースアセット構成の表示名
routeConfig.remarkクロスソースアセット構成の説明Stringいいえ構成の説明
routeConfig.viewResourceRouteTypeeventStringはいアセットタイプ。値の範囲は[tag, event, user, dim]
routeConfig.modelTablehive.ta.table_2321Stringはいデータソース
routeConfig.highOrWideEnumwideStringはいロング/ワイドテーブル。値の範囲は[high, wide](イベントタイプはワイドテーブルのみ対応)
(event)
routeConfig.configEntityIdColumnentity_idStringいいえ主体列
routeConfig.dataPartTypeEnumcolumn_date_partStringはいデータパーティショニング方式。値の範囲は[column_date_part, auto_push_logic]
routeConfig.configDateColumn#event_timeStringいいえ日付情報列 (dataPartTypeEnum=column_date_partの場合は必須)
routeConfig.configDateFormatyyyy-MM-ddStringいいえ日付情報のフォーマット(dataPartTypeEnum=column_date_partの場合は必須)
routeConfig.configBusinessPushLogicStringいいえプッシュダウンロジック (dataPartTypeEnum=auto_push_logicの場合は必須)
routeConfig.businessEventNameSelectEnumraw_columnStringはいイベント名の取得方法。値の範囲は[val, raw_column]
routeConfig.configEventNameloginStringいいえイベント名 (businessEventNameSelectEnum=valの場合は必須)
routeConfig.configEventNameColumn#event_nameStringいいえイベント名列 (businessEventNameSelectEnum=raw_columnの場合は必須)
routeConfig.businessEventDateValueSelectEnumraw_columnStringはいイベント時間の取得方法。値の範囲は[raw_column, expression]
routeConfig.configEventTimeColumn#event_timeStringいいえイベント時間列 (businessEventDateValueSelectEnum=raw_columnの場合は必須)
routeConfig.configEventTimeLogicdate_parse( "ev_time", '%Y-%m-%d %H:%i:%s' )Stringいいえイベント時間ロジック (businessEventDateValueSelectEnum=expressionの場合は必須)
routeConfig.businessEventZoneOffsetSelectEnumraw_columnStringはいイベントタイムゾーンの取得方法。値の範囲は[raw_column, val, expression]
routeConfig.configEventTimeTZColumn#zone_offsetStringいいえイベントタイムゾーン列 (businessEventZoneOffsetSelectEnum=raw_columnの場合は必須)
routeConfig.configEventTimeTZ8Stringいいえイベントタイムゾーン (businessEventZoneOffsetSelectEnum=valの場合は必須)
routeConfig.configEventTimeTZLogiccast( substr( "zone_offset", 3, 9 ) as double )Stringいいえイベントのタイムゾーンロジック (businessEventZoneOffsetSelectEnum=expressionの場合は必須)
(tag)
routeConfig.configEntityColumnentity_idStringはい主体列
routeConfig.configEntityNameuser_loginStringはい分析主体-- 送信する分析主体の表示名
routeConfig.configTagNameColumntag_name_colStringはいタグ名列
routeConfig.configTagValueColumntag_value_colStringはいタグ値列
routeConfig.tagHistoryVersiononlyLastString

はい

タグ日付バージョン。値の範囲は[onlyHistory,onlyLast,historyAndLast]
routeConfig.configDateColumn#event_timeStringいいえ日付情報列 (任意) 日付パーティションがある列を選択します。日付バージョンが「最新バージョンのみ」の場合は入力不要です
routeConfig.configTagDateZoneOffsetVal8Stringいいえタグ日付タイムゾーン。日付情報列が空でない場合は必須
routeConfig.configDateFormatyyyy-MM-ddStringいいえ日付情報のフォーマット。日付情報列が空でない場合は必須
(user)
routeConfig.configDataUpdateTimeColumn#update_timeStringいいえデータ更新日時カラム
(dim)
routeConfig.configEntityIdColumn#idいいえ主体列
routeConfig.configEntityProp#loginいいえ主体プロパティ
routeConfig.propTypeuserPropEnumいいえ主体プロパティタイプ [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.routeCodeFromEventroute_v1Stringはいクロスソースアセット構成名
eventMappings.targetEventNameloginStringはい出力されたイベント名
eventMappings.sourceEventList( 'event_1' , 'event_2' )Stringいいえオリジナルイベント一覧
eventMappings.targetEventDescログインStringいいえ出力されたイベントの表示名
eventMappings.remarkOSSログインStringいいえ備考
-
propMappings-Array-
propMappings.routeCodeFromProproute_v1Stringはいクロスソースアセット構成名
propMappings.sourcePropNameaccountStringいいえ元のプロパティ名
propMappings.targetPropNameaccountStringはい出力プロパティ名
propMappings.targetPropDescアカウントStringいいえ出力プロパティの表示名
propMappings.sqlExpressionFromProp-Stringいいえ値の取得方式
propMappings.targetPropTypeEnumStringStringはい出力プロパティのタイプ
propMappings.isPublictrueBooleanいいえ共通イベントプロパティかどうか
propMappings.propConfigRemark-Stringいいえ備考
-
eventPropMap-Array-
eventPropMap.routeCodeFromEventPropMaproute_v1Stringはいクロスソースアセット構成名
eventPropMap.eventName-Stringはい出力されたイベント名
eventPropMap.propName-Stringはい出力プロパティ名
-
tagMappings-Array
tagMappings.routeCodeFromTagroute_v1Stringはいクロスソースアセット構成名
tagMappings.routeResourceKeytag_1Stringいいえ元のタグ名
tagMappings.targetTagNametag_nameStringはい出力タグ名
tagMappings.targetTagDesctag_descStringいいえ出力タグ表示名
tagMappings.sqlExpression-Stringいいえ値の取得方式
tagMappings.routeSelectTypeEnumnumberStringはい値の範囲は[number,string,datetime,bool,array]
tagMappings.extRemark-Stringいいえ備考
tagMappings.extValueZoneOffset8Stringいいえ値のタイムゾーン
-
userPropMapping
userPropMapping.routeCodeFromUserProproute_v1Stringはいクロスソースアセット構成名
userPropMapping.sourcePropNameaccountStringいいえ元のプロパティ名
userPropMapping.targetPropNameaccountStringはい出力プロパティ名
userPropMapping.targetPropDescアカウントStringいいえ出力プロパティの表示名
userPropMapping.sqlExpressionFromProp-Stringいいえ値の取得方式
userPropMapping.targetPropTypeEnumStringStringはい出力プロパティのタイプ[]
userPropMapping.propConfigRemark-Stringいいえ備考
userPropMapping.enumValues["user1","user2"]List<String>いいえ列挙値
-
dimPropMapping
dimPropMapping.routeCodeFromDimroute_v1Stringはいクロスソースアセット構成名
dimPropMapping.sourceNameFormDimaccountStringいいえ元のプロパティ名
dimPropMapping.targetNameFromDimaccountStringはい出力プロパティ名
dimPropMapping.targetDescFromDimアカウントStringいいえ出力プロパティの表示名
dimPropMapping.sqlExpressionFromProp-Stringいいえ値の取得方式
dimPropMapping.targetTypeEnumStringStringはい出力プロパティのタイプ[]
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パラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
routeId12Longはいクロスソース構成ID
resourceTypeTAGenumはい出力アセットタイプ[TAG, EVENT_PROP, U_PROP, DIM_PROP]
resourceCodetag_1Stringはい出力アセット名

リクエストBodyパラメータ

["t_1","t_2"]

成功レスポンスの例

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

4. アセットスキャン-アセットスキャンタスクの送信​

インターフェースURL

/open/route/searchTask/submit

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
isEventBooleanいいえクロスソース構成ID。イベントタイプかどうか(デフォルトはfalse)。イベントのみをスキャンする場合はisEvent=trueの指定が必要です

リクエストBodyパラメータ

{
"routeConfig": {
"viewResourceRouteType":"event",//アセットタイプ[tag,event,user,dim]
"modelTable":"",//データソース、==dataSource
"highOrWideEnum":"",//ロング/ワイドテーブル[high,wide]
"configTagNameColumn":"",//タグ名列
"configTagValueColumn":"",//タグ値列
"businessEventNameSelectEnum":""//イベント名の取得方法[raw_column]
"configEventNameColumn":""//イベント名列
},
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
viewResourceRouteTypetagEnumはいアセットタイプ [tag, event, user, dim]
modelTablehive.ta.v_event_1Stringはいデータソース
highOrWideEnumhighEnumはいロング/ワイドテーブル[high,wide](highはtagタイプのみ対応)
configTagNameColumn

tag_name_column

String

いいえ

タグ名列 (viewResourceRouteType=tagの場合は必須)
configTagValueColumntag_value_columnStringいいえタグ値列(viewResourceRouteType=tagの場合は必須)
businessEventNameSelectEnumraw_columnEnum

いいえ

イベント名の取得方法[raw_column](viewResourceRouteType=eventの場合は必須。raw_columnを固定で渡す)

configEventNameColumn#event_nameString

いいえ

イベント名列(viewResourceRouteType=event、isEvent=trueの場合は必須)
configEntityIdColumn#user_idStringいいえ主体列(viewResourceRouteType=dimの場合は必須)

成功レスポンスの例

{
"data": {
"taskId":"***"
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
パラメータ名サンプル値パラメータタイプパラメータの説明
data-Object
data.taskIdStringスキャンタスクの一意の識別子

5. アセットスキャン-アセットスキャンステータスの確認​

インターフェースURL

/open/route/searchTask/check

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
taskIdxxxStringはいスキャンタスクの一意の識別子

成功レスポンスの例

{
"data": {
"state":"error" //running、success、error
"msg":"失敗の原因" // it is existing when status == error
},
"return_code": 0,
"return_message": "success",
"showStackMessage": false
}
パラメータ名サンプル値パラメータタイプパラメータの説明
data-Object
data.statesuccessEnumスキャンステータス[running, success, error]
data.msg-String失敗の原因

6. アセットスキャン-スキャン結果の取得​

インターフェースURL

/open/route/searchTask/result

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
taskIdxxxStringはいスキャンタスクの一意の識別子

成功レスポンスの例

//タグ
{
//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.sourceNametag_1String元のタグ名
data.sourceSelectTypeStringString元のタグタイプ
data.targetNametag_1Stringターゲットアセット名
data.targetSelectTypeStringStringターゲットアセットタイプ

イベント

パラメータ名サンプル値パラメータタイプパラメータの説明
data-Arrayイベント名

7. クロスソース構成の詳細の取得​

インターフェースURL

/open/route/get

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
id10Integerはい構成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
}
パラメータ名サンプル値パラメータタイプパラメータの説明
id24101Integer構成ID
modelTablehive.ta.tag2Stringデータソース
modelTableDesctag2_descStringデータソースの説明
remarkremarkString備考
resourceTypetagStringアセットタイプ[tag, event]
routeCoderoute_codeStringクロスソースアセット構成名
routeDescroute_decStringクロスソースアセット構成の説明
wideTabletruebooleanワイドテーブルかどうか
msgMap[]List<String>構成チェックのエラーリスト
assetsList[]List<String>アセット名リスト
checkStatuscheck_successEnumチェックステータス[un_checked, checking, check_success, check_fail]
configDesc-Object構成詳細
configDesc.part_date_typebigintString日付パーティションタイプ
configDesc.part_date_formatyyyyMMddString日付パーティション形式
configDesc.part_date_column$part_dateString日付パーティション列
resourceType=tag
configDesc.tag_value_columntag_value_tmStringタグ値列
configDesc.business_part_date_type履歴バージョンのみString

タグ日付バージョン

configDesc.entity_column#varchar_idString分析主体列(resourceType=tag)
configDesc.tag_zone_offset8Stringタグ日付タイムゾーン(resourceType=tag)
configDesc.tag_entity_nameユーザーString分析主体(resourceType=tag)
configDesc.tag_name_columncluster_nameStringタグ日付列(resourceType=tag)
resourceType=event
configDesc.business_data_part_typecolumn_date_partStringデータパーティショニング方式
configDesc.business_event_date_value_selectexpressionStringイベント時間の取得方法
configDesc.business_event_name_selectraw_columnStringイベント名の取得方法
configDesc.business_event_zone_offset_selectraw_columnStringイベントタイムゾーンの取得方法
configDesc.event_name_columnevent_name_renameStringイベント名列
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.id457963Integerタグマッピングid
assetsResourceList.routeResourceKeytag_nameString元のタグ名
assetsResourceList.sourceTagTypeStringString元のタグタイプ
assetsResourceList.sqlExpression-String値の取得方式
assetsResourceList.targetSelectTypeNumberString出力タグタイプ
assetsResourceList.targetTagDescタグString出力タグ表示名
assetsResourceList.targetTagNametag_aString出力タグ名
assetsResourceList.enums[1,2,3]Array列挙値のサンプル
assetsResourceList.lastUpdateEnumTime2024-01-19String列挙値の最終更新時間
assetsResourceList.enumSizeInteger列挙値の個数
assetsResourceList.checkStatusEnumcheck_failEnumチェックステータス[un_checked, checking, check_success, check_fail]
assetsResourceList.checkStatusMsg主体列のタイプが分析主体のタイプと一致しませんStringエラーメッセージ
assetsResourceList.extConfig-Object拡張情報
assetsResourceList.extConfig.remark-String備考
assetsResourceList.extConfig.valueZoneOffset8String

タグのタイムゾーン

eventResourceMap-Objectイベントアセットリスト
eventResourceMap.eventPropMappings-Arrayイベントプロパティの関係
eventResourceMap.eventPropMappings.targetEventNameloginString出力されたイベント名
eventResourceMap.eventPropMappings.targetEventPropName#account_idString出力プロパティ名
eventResourceMap.eventProps-Arrayイベントプロパティ一覧
eventResourceMap.eventProps.routeResourceKey#account_idString元のプロパティ名
eventResourceMap.eventProps.sourceEventPropTypevarcharString元のプロパティタイプ
eventResourceMap.eventProps.sqlExpression-String

値の取得方式

eventResourceMap.eventProps.targetEventPropNameaccount_idString出力プロパティ名
eventResourceMap.eventProps.targetEventPropDesc-String出力プロパティの表示名
eventResourceMap.eventProps.targetSelectTypestringString出力プロパティのタイプ
eventResourceMap.eventProps.checkStatusEnumcheck_successEnumチェックステータス
eventResourceMap.eventProps.checkStatusMsg-Stringエラーメッセージ
eventResourceMap.eventProps.enums["1","2"]Array

列挙値のサンプル

eventResourceMap.eventProps.lastUpdateEnumTime2023-01-12String最終更新時間
eventResourceMap.eventProps.enumSize1203Integer列挙値の個数
eventResourceMap.eventProps.extConfig-Object拡張情報
eventResourceMap.eventProps.extConfig.isPublic1Integer共通イベントプロパティかどうか(1:はい、0:いいえ)
eventResourceMap.eventProps.extConfig.remark-String備考
eventResourceMap.events-Arrayイベントリスト
eventResourceMap.events.targetEventDescクロスソース-イベント参加String

出力されたイベントの表示名

eventResourceMap.events.targetEventList-String出力イベントリスト
eventResourceMap.events.targetEventNameactivity_attendString出力されたイベント名
eventResourceMap.events.checkStatusEnumcheck_successEnumチェックステータス
eventResourceMap.events.checkStatusMsg-Stringエラーメッセージ
userResourceList-Arrayエンティティアセットリスト
userResourceList.checkStatusEnumcheck_successEnumチェックステータス
userResourceList.checkStatusMsg-Stringエラーメッセージ
userResourceList.routeResourceKey#account_idString元のプロパティ名
eventResourceMap.eventProps.sqlExpression-String

値の取得方式

userResourceList.sourceUserPropTypestringString元のプロパティタイプ
userResourceList.targetSelectTypestringString出力プロパティのタイプ
userResourceList.targetUserPropDesc-String

出力プロパティの表示名

userResourceList.targetUserPropNameaccount_idString出力プロパティ名
dimResourceMap-Arrayディメンションアセットリスト
dimResourceMap.checkStatusEnumcheck_successEnumチェックステータス
dimResourceMap.checkStatusMsg-Stringエラーメッセージ
dimResourceMap.extConfig.remark-String備考
dimResourceMap.routeResourceKey#account_idString元のプロパティ名
dimResourceMap.sqlExpression-String

値の取得方式

dimResourceMap.sourceDimPropType-String元のプロパティタイプ
dimResourceMap.targetSelectTypestringString出力プロパティのタイプ
dimResourceMap.targetUserPropDesc-String

出力プロパティの表示名

dimResourceMap.targetUserPropNameaccount_idString出力プロパティ名

8. ルート設定の一括チェック​

インターフェースURL

/open/route/checkBatch

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID

リクエストBodyパラメータ

//クロスソース構成idリスト
[1, 2]

成功レスポンスの例

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

9. 構成へのアセットの増分追加​

インターフェースURL

/open/route/uploadAsset

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102Integerはいプロジェクト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":["",]//列挙ファイルマーカー
}
]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
routeCodeexample_route_codeStringはいルートコード。更新するルート設定を識別するために使用します
tagMappings-Arrayはいタグマッピングリスト
tagMappings.routeCodeFromTagexample_route_codeStringはいクロスソースアセット構成名
tagMappings.routeResourceKeyoriginal_tag_nameStringいいえ元のタグ名
tagMappings.targetTagNameoutput_tag_name

String

はい出力タグ名
tagMappings.targetTagDesc出力タグ表示名Stringいいえ出力タグ表示名
tagMappings.sqlExpressionSELECT tag_value FROM tag_table WHERE condition = ?

String

いいえ値の取得方式(SQL式)
tagMappings.routeSelectTypeEnumstring

String

はい出力タグタイプ。値の範囲は[number,string,datetime,bool,array]
tagMappings.extRemarkタグマッピングの備考Stringいいえ備考
tagMappings.extValueZoneOffset8Stringいいえ値のタイムゾーン
tagMappings.enumKeytag_enum_keyStringいいえ列挙ファイルマーカー
tagMappings.enumValues["value1", "value2", "value3"]List<String>いいえ列挙値リスト(OpenAPIインターフェースで直接渡す)
eventMappings-Arrayはいイベントマッピングリスト
eventMappings.routeCodeFromEventexample_route_codeStringはいクロスソースアセット構成名
eventMappings.targetEventNameoutput_event_nameStringはい出力されたイベント名
eventMappings.sourceEventListoriginal_event_listStringいいえオリジナルイベント一覧
eventMappings.targetEventDesc出力されたイベントの表示名Stringいいえ出力されたイベントの表示名
eventMappings.remarkイベントマッピングの備考Stringいいえ備考
propMappings-Arrayはいプロパティマッピングリスト
propMappings.routeCodeFromPropexample_route_codeStringはいクロスソースアセット構成名
propMappings.sourcePropNameoriginal_prop_nameStringいいえ元のプロパティ名
propMappings.targetPropNameoutput_prop_nameStringはい出力プロパティ名
propMappings.targetPropDesc出力プロパティの表示名Stringいいえ出力プロパティの表示名
propMappings.sqlExpressionFromPropproperty_expressionStringいいえ値の取得方式(SQL式)
propMappings.targetPropTypeEnumstringStringはい出力プロパティのタイプ
propMappings.isPublictrueBooleanいいえ共通イベントプロパティかどうか
propMappings.propConfigRemarkプロパティマッピングの備考Stringいいえ備考
propMappings.enumKeyprop_enum_keyStringいいえ列挙ファイルマーカー
propMappings.enumValues["prop_value1", "prop_value2"]List<String>いいえ列挙値リスト(OpenAPIインターフェースで直接渡す)
eventPropMap-Arrayはいイベントプロパティマッピングリスト
eventPropMap.routeCodeFromEventPropMapexample_route_codeStringはいクロスソースアセット構成名
eventPropMap.eventNameoutput_event_nameStringはい出力されたイベント名
eventPropMap.propNameoutput_prop_nameStringはい出力プロパティ名
userPropMappings
userPropMappings.routeCodeFromUserProproute_v1Stringはいクロスソースアセット構成名
userPropMappings.sourcePropNameaccountStringいいえ元のプロパティ名
userPropMappings.targetPropNameaccountStringはい出力プロパティ名
userPropMappings.targetPropDescアカウントStringいいえ出力プロパティの表示名
userPropMappings.sqlExpressionFromProp-Stringいいえ値の取得方式
userPropMappings.targetPropTypeEnumStringStringはい出力プロパティのタイプ[]
userPropMappings.propConfigRemark-Stringいいえ備考
userPropMappings.enumValues["user1","user2"]List<String>いいえ列挙値
dimPropMappings
dimPropMappings.routeCodeFromDimroute_v1Stringはいクロスソースアセット構成名
dimPropMappings.sourceNameFromDimaccountStringいいえ元のプロパティ名
dimPropMappings.targetNameFromDimaccountStringはい出力プロパティ名
dimPropMappings.targetDescFromDimアカウントStringいいえ出力プロパティの表示名
dimPropMappings.sqlExpressionFromProp-Stringいいえ値の取得方式
dimPropMappings.targetTypeEnumStringStringはい出力プロパティのタイプ[]
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:

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId102IntegerはいプロジェクトID
routeCodeexample_route_codeStringはいルートコード。更新するルート設定を識別するために使用します

resourceType

TAGenumはい

出力アセットタイプ[TAG, EVENT_PROP, U_PROP, DIM_PROP]

resourceCode

tag_1

String

はい

出力アセット名

resopnse:file

このページは役に立ちましたか?