13.3. ファイルフォーマット(列挙)¶
列挙のインポートファイルのファイルフォーマットを説明します。
列挙のインポートファイルは JSON 形式です。
列挙カテゴリ、列挙を配列の要素として記述します。
- 列挙カテゴリには以下のキーを指定します。
- type
- “CATEGORY” を指定します。
- identify
- 列挙カテゴリIDを指定します。
- sortNumber
- ソート順を数値で指定します。
- name
- 国際化項目
- description
- 国際化項目
- children
- 列挙カテゴリ、列挙を配列の要素として記述します。
- 列挙には以下のキーを指定します。
- type
- “ENUMERATION” を指定します。
- identify
- 列挙IDを指定します。
- parentId
- 親カテゴリIDを指定します。
- sortNumber
- ソート順を数値で指定します。
- name
- 国際化項目
- description
- 国際化項目
- enumerationItems
- 列挙項目を配列の要素として記述します。
- enabled
- この列挙が有効か無効化を true または false で指定します。
- 列挙項目には以下のキーを指定します。
- label
- 国際化項目
- value
- 列挙項目の値を指定します。
- sortNumber
- ソート順を数値で指定します。
- 国際化項目には以下のキーを指定します。
- default
- デフォルトの値を指定します。
- ロケール名
- ロケール名に該当する値を指定します。
ファイルの例
[
{
"type": "CATEGORY",
"identify": "c1",
"sortNumber": 2,
"name": {
"default": "bar"
},
"description": {
"default": null
},
"children": [
{
"type": "ENUMERATION",
"identify": "e1",
"parentId": "c1",
"sortNumber": 0,
"name": {
"default": "Sample Enumeration",
"ja": "サンプル列挙名",
"en": "Sample Enumeration Name",
"zh_CN": "Sample Enumeration Name zh_CN"
},
"description": {
"default": "This is a sample enumeration.",
"ja": "これはサンプルの列挙です。",
"en": "This is a sample enumeration.",
"zh_CN": "This is a sample enumeration zh_CN."
},
"enumerationItems": [
{
"label": {
"default": "Foo",
"ja": "ふー",
"en": "Foo",
"zh_CN": "fff"
},
"value": "foo",
"sortNumber": 0
},
{
"label": {
"default": "Bar"
},
"value": "bar",
"sortNumber": 1
},
{
"label": {
"default": "Baz",
"ja": "ばず",
"en": "Baz",
"zh_CN": "zzz"
},
"value": "bar",
"sortNumber": 2
}
],
"enabled": true
}
]
}
]