メタデータテンプレート
ファイルやフォルダに適用可能なメタデータのテンプレート。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | メタデータテンプレートのID。 |
type | enum<string> | はい | 値は常にmetadata_templateになります。 使用可能なオプション: metadata_template. |
scope | string | いいえ | メタデータテンプレートのスコープは、globalまたはenterprise_*のいずれかになります。globalスコープは、Boxを使用するすべての会社が利用できるテンプレートに使用されます。enterprise_*スコープは、特定の会社内で作成されたテンプレートを表します (*はその会社のID)。 |
templateKey | string | いいえ | テンプレートの一意の識別子。この識別子は、メタデータテンプレートが適用される会社のscope全体で一意ですが、会社を越えて一意であるとは限りません。 |
displayName | string | いいえ | テンプレートの表示名。Boxウェブアプリとモバイルアプリに表示されます。 |
hidden | boolean | いいえ | このテンプレートをBoxウェブアプリのUIに表示するか、APIを介した使用のみを目的とするかを定義します。 |
fields | array of object | いいえ | テンプレートに含まれるテンプレートフィールドの順序付きリスト。各フィールドは、通常のテキストフィールド、日付フィールド、数値フィールド、単一または複数選択リストのいずれかになります。 |
copyInstanceOnItemCopy | boolean | いいえ | ファイルまたはフォルダのコピー時にメタデータを含めるかどうか。 |
例
{
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"type": "metadata_template",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"displayName": "Product Info",
"hidden": true,
"fields": [
{
"type": "string",
"key": "category",
"displayName": "Category",
"description": "The category",
"hidden": true,
"options": [
{
"key": "Category 1",
"id": "45dc2849-a4a7-40a9-a751-4a699a589190"
}
],
"taxonomyKey": "locationTaxonomy",
"taxonomyId": "05ece6d7-fec4-4d3f-bfd2-36fd4dddea97",
"namespace": "enterprise_123456",
"optionsRules": {
"multiSelect": true,
"selectableLevels": [
1,
2
]
},
"id": "822227e0-47a5-921b-88a8-494760b2e6d2"
}
],
"copyInstanceOnItemCopy": true
}
メタデータテンプレート
メタデータテンプレートのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of メタデータテンプレート | いいえ | メタデータテンプレートのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"type": "metadata_template",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"displayName": "Product Info",
"hidden": true,
"fields": [
{
"type": "string",
"key": "category",
"displayName": "Category",
"description": "The category",
"hidden": true,
"options": [
{
"key": "Category 1",
"id": "45dc2849-a4a7-40a9-a751-4a699a589190"
}
],
"taxonomyKey": "locationTaxonomy",
"taxonomyId": "05ece6d7-fec4-4d3f-bfd2-36fd4dddea97",
"namespace": "enterprise_123456",
"optionsRules": {
"multiSelect": true,
"selectableLevels": [
1,
2
]
},
"id": "822227e0-47a5-921b-88a8-494760b2e6d2"
}
],
"copyInstanceOnItemCopy": true
}
]
}