文字列メタデータフィールド
文字列メタデータフィールド
string
タイプのメタデータフィールドは、標準のテキストフィールドとしてユーザーに表示されます。
文字列フィールドの作成
string
フィールドは、メタデータテンプレートの作成時、またはaddField
操作によるテンプレートの更新時にメタデータテンプレートに追加できます。
string
フィールドの必須属性は、type
、displayName
、およびkey
です。
{
"scope": "enterprise",
"displayName": "Customer",
"fields": [
{
"type": "string",
"key": "name",
"displayName": "Name",
"description": "The customer's legal name",
"hidden": false
}
]
}
必要に応じて、UIでユーザーに表示されるdescription
を指定できます。また、このフィールドをhidden
に設定して、ウェブアプリとモバイルアプリでユーザーに表示されないようにすることもできます。
文字列フィールドの更新
string
テンプレートフィールドは、このフィールドが属するテンプレートを更新することで更新できます。テンプレートの更新 は、ファイルまたはフォルダにすでに割り当てられているテンプレートも確実に更新される操作によって行われます。
string
メタデータフィールドを更新する際、関連する操作は、フィールドのkey
、displayName
、description
、およびhidden
の値を変更するのに使用できるeditField
操作のみです。
[
{
"op": "editField",
"fieldKey": "name",
"data": {
"displayName": "Customer Name",
"description": "The contact name at the customer",
"key": "customer_name",
"hidden": true
}
}
]