メタデータ | サポートサイト

会員などのマスタ情報にApps固有の項目を追加し、値を保持することが可能となります。
自由項目同様に型・サイズ等を設定します。

メタデータの定義

FREE_TABLE_NAME

テーブル名です。

FREE_TABLE_ITEM_NAME

テーブル項目名です。テーブル名にメタデータを指定した場合、名称のプレフィックスとして「APP_CD:」が必須です。

REGIST_FLG

使用するかを登録します。null:使用しない　1:使用する

DISP_NAME

画面表示名です。

DISP_COMMENT

画面コメントです。決済管理画面に表示する場合には"<", ">", """, "&", ",", "\"はエスケープされ、半角スペースは 、改行は<br>タグに変換されます。

FORM_TYPE

フォーム種別です。0:ラベル（表示のみ）、1:1行テキスト、2:プルダウン、3:チェックボックス、4:ラジオボタン、5:テキストエリア、6:パスワード、7:画像

FORM_OPTION

フォームの選択肢です。「値1：表示名1,値2:表示名2」のようにパラメータ値と表示値を「:」で区切り、項目を「,」区切りで指定します。

FORM_SIZE

テキスト項目横幅です。

FORM_MAXLENGTH

テキスト項目最大入力桁数です。

FORM_TEXTAREA_COLS

テキストエリア項目横幅です。

FORM_TEXTAREA_ROWS

テキストエリア項目縦幅

CHECK_PROPERTY

入力値の種別です。入力値チェックで使用します。1:半角、2:半角、全角両方許可、3:数値、4:日付、5:電話番号、6:メールアドレス、7:コード（未対応）、8:日付

CHECK_NEED

入力必須かどうかを示します。1の場合、必須です。

CHECK_BYTE_SIZE

入力チェック時の桁数です。

会員情報

POST members.json

{
    "MEMBER_ID": 1, 
    "metadata": {
        "KEY1": "VALUE1", 
        "KEY2": "VALUE2"
    }
}

※詳細はデータアクセスAPI ＞ 会員関連

PUT members/1.json

{
    "FREE_ITEM1": 1, 
    "metadata": {
        "KEY1": "VALUE1"
    }
}

※詳細はデータアクセスAPI ＞ 会員関連

決済方法

POST payment_ways.json

{
    "KESSAI_CD": "TEST_PAYMENT_WAY", 
    "metadata": {
        "KEY1": "VALUE1", 
        "KEY2": "VALUE2"
    }
}

※詳細はデータアクセスAPI ＞ 決済方法関連

メールバリデート

PUT mail_validate_temp/1.json

{
    "metadata": {
        "KEY1": "VALUE1"
    }
}

※詳細はデータアクセスAPI ＞ メール確認一時関連

注文

POST orders.json

{
    "ORDER_NO": "1", 
    "metadata": {
        "KEY1": "VALUE1", 
        "KEY2": "VALUE2"
    }
}

※詳細はデータアクセスAPI ＞ 注文関連

PUT orders/1.json

{
    "metadata": {
        "KEY1": "VALUE1"
        "KEY2": "VALUE2"
    }
}

※詳細はデータアクセスAPI ＞ 注文関連

javaで記述する際のサンプル

メタデータの定義

FormDefinitionsService fs = EbisumartService.getFormDefinitionsService();
FormDefinition fdata = fs.getFormDefinition("MEMBER_METADATA", "APP_CD:META_NAME");

// 定義を設定
FormDefinition fd = new FormDefinition();
fd.setFreeTableName("MEMBER_METADATA");
fd.setFreeTableItemName("APP_CD:META_NAME");
fd.setDispName("会員メタデータサンプル");
fd.setFormType("0");
fd.setCheckProperty("1");

// 定義の登録
fs.addNewFormDefinition(fd);

メタデータの設定

// 会員にメタデータ情報をセット
Metadata metadata = new Metadata();
metadata.set("KEY1", "VALUE1");
Member member = new Member();
member.setMemberId(memberId);
member.setMetadata(metadata);

// 会員情報の更新
EbisumartService.getMembersService().updateMember(member);

メタデータの取得

// 取得するメタデータを指定
List selectColumns = new ArrayList(){
	{
	add("metadata(KEY1)");
	}
};

// 会員情報を取得
Member member = EbisumartService.getMembersService().getMemberById(memberId, selectColumns);

// メタ情報を取得
String metaDataValue = (String) member.getMetadata().get("VALUE1");