複数選択メタデータフィールド
複数選択メタデータフィールド
multiSelect
タイプのメタデータフィールドは、ドロップダウンリストとしてユーザーに表示されます。ユーザーはリストから複数の項目を選択できます。
multiSelect
フィールドの作成
multiSelect
フィールドは、メタデータテンプレートの作成時、またはaddField
操作によるテンプレートの更新時にメタデータテンプレートに追加できます。
multiSelect
フィールドの必須属性は、type
、displayName
、key
、およびオプションのリストです。
{
"scope": "enterprise",
"displayName": "Contract",
"fields": [
{
"type": "multiSelect",
"key": "box_entity",
"displayName": "Box Entity",
"description": "The Box entity that this contract belongs to",
"hidden": false,
"options": [
{"key": "Box, Inc"},
{"key": "Box.com (UK) Ltd."},
{"key": "KK Box Japan"}
]
}
]
}
必要に応じて、UIでユーザーに表示されるdescription
を指定できます。また、このフィールドをhidden
に設定して、ウェブアプリとモバイルアプリでユーザーに表示されないようにすることもできます。
multiSelect
フィールドの更新
multiSelect
テンプレートフィールドは、このフィールドが属するテンプレートを更新することで更新できます。テンプレートの更新は、ファイルまたはフォルダにすでに割り当てられているテンプレートも確実に更新される操作によって行われます。
基本的なフィールド値の変更
multiSelect
メタデータフィールドを更新する際に可能な操作の1つとして、フィールドのkey
、displayName
、description
、およびhidden
の値を変更するのに使用できるeditField
操作があります。
[
{
"op": "editField",
"fieldKey": "box_entity",
"data": {
"displayName": "Box Entities",
"key": "box_entities"
}
}
]
オプションの追加
multiSelect
フィールドにオプションを追加するには、addMultiSelectOption
操作を使用します。この操作では、fieldKey
に、変更するmultiSelect
フィールドのキーを設定するほか、data
オブジェクトには、追加する新しいオプションのkey
を指定する必要があります。
[
{
"op": "addMultiSelectOption",
"fieldKey": "box_entity",
"data": {
"key": "Box (NL) BV"
}
}
]
オプションのリストは次のようになります。
...
"options": [
{"key": "Box, Inc"},
{"key": "Box.com (UK) Ltd."},
{"key": "KK Box Japan"},
{"key": "Box (NL) BV"}
]
...
オプションの並べ替え
multiSelect
フィールドでオプションを並べ替えるには、reorderMultiSelectOptions
操作を使用します。この操作では、fieldKey
に、変更するmultiSelect
フィールドのキーを設定するほか、multiSelectOptionKeys
配列にはオプションのキーを順番に指定する必要があります。
[
{
"op": "reorderMultiSelectOptions",
"fieldKey": "box_entity",
"multiSelectOptionKeys": [
"Box, Inc",
"Box.com (UK) Ltd.",
"Box (NL) BV",
"KK Box Japan"
]
}
]
オプションのリストは次のようになります。
...
"options": [
{"key": "Box, Inc"},
{"key": "Box.com (UK) Ltd."},
{"key": "Box (NL) BV"},
{"key": "KK Box Japan"}
]
...
オプションの編集
multiSelect
フィールドのオプションを編集するには、editMultiSelectOption
操作を使用します。この操作では、fieldKey
に、変更するmultiSelect
フィールドのキーを設定し、multiSelectOptionKey
に、フィールドオプションのキーを設定する必要があります。最後に、data
オブジェクトには、フィールドオプションの新しいkey
を指定する必要があります。
[
{
"op": "editMultiSelectOption",
"fieldKey": "box_entity",
"multiSelectOptionKey": "Box (NL) BV",
"data": {
"key": "Box.nl BV"
}
}
]
オプションのリストは次のようになります。
...
"options": [
{"key": "Box, Inc"},
{"key": "Box.com (UK) Ltd."},
{"key": "Box.nl BV"},
{"key": "KK Box Japan"}
]
...
オプションの削除
multiSelect
フィールドからオプションを削除するには、removeMultiSelectOption
操作を使用します。この操作では、fieldKey
に、変更するmultiSelect
フィールドのキーを設定し、multiSelectOptionKey
に、削除するフィールドオプションのキーを設定します。
[
{
"op": "removeMultiSelectOption",
"fieldKey": "customer_state",
"multiSelectOptionKey": "KK Box Japan"
}
]
オプションのリストは次のようになります。
...
"options": [
{"key": "Box, Inc"},
{"key": "Box.com (UK) Ltd."},
{"key": "Box.nl BV"}
]
...