最新バージョン
フォルダにメタデータインスタンスを作成
APIバージョン 2024.0
メタデータテンプレートのインスタンスをフォルダに適用します。
ほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できるglobal.propertiesテンプレートは除きます。
Boxウェブアプリでメタデータテンプレートを表示するために、企業では、管理コンソールでユーザーの [フォルダレベルメタデータのカスケード] を有効にするよう設定する必要があります。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
stringパス内必須
globalメタデータテンプレートのスコープ
次の値のいず れか1つ: global,enterprise
stringパス内必須
propertiesメタデータテンプレートの名前
リクエスト本文
object本文内
"Aaron Levie"メタデータテンプレートに存在する各フィールドの値。global.propertiesテンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。
レスポンス
application/jsonメタデータインスタンス (Full)
テンプレートに適用されたデータを含む、フォルダに適用されたテンプレートのインスタンスを返します。
application/jsonクライアントエラー
リクエスト本文が無効な場合にエラーを返します。
schema_validation_failed- リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。
application/jsonクライアントエラー
フォルダテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。
not_found- フォルダが見つからないか、ユーザーがフォルダにアクセスできません。instance_tuple_not_found- メタデータテンプレートが見つかりませんでした。
application/jsonクライアントエラー
このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。
tuple_already_exists- メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"audience": "internal",
"documentType": "Q1 plans",
"competitiveDocument": "no",
"status": "active",
"author": "Jones",
"currentState": "proposal"
}'TypeScript Gen
await client.folderMetadata.createFolderMetadataById(
folder.id,
'global' as CreateFolderMetadataByIdScope,
'properties',
{ ['abc']: 'xyz' },
);Python Gen
client.folder_metadata.create_folder_metadata_by_id(
folder.id, CreateFolderMetadataByIdScope.GLOBAL, "properties", {"abc": "xyz"}
).NET Gen
await client.FolderMetadata.CreateFolderMetadataByIdAsync(folderId: folder.Id, scope: CreateFolderMetadataByIdScope.Global, templateKey: "properties", requestBody: new Dictionary<string, object>() { { "abc", "xyz" } });Java
BoxFolder folder = new BoxFolder(api, "id");
folder.createMetadata(new Metadata().add("/foo", "bar"));Python
metadata = {
'foo': 'bar',
'baz': 'quux',
}
applied_metadata = client.folder(folder_id='22222').metadata().create(metadata)
print(f'Applied metadata in instance ID {applied_metadata["$id"]}').NET
var metadataValues = new Dictionary<string, object>()
{
{ "audience", "internal" },
{ "documentType", "Q1 plans" },
{ "competitiveDocument", "no" },
{ "status", "active" },
{ "author": "M. Jones" },
{ "currentState": "proposal" }
};
Dictionary<string, object> metadata = await client.MetadataManager
.CreateFolderMetadataAsync(folderId: "11111", metadataValues, "enterprise", "marketingCollateral");Node
var metadataValues = {
audience: "internal",
documentType: "Q1 plans",
competitiveDocument: "no",
status: "active",
author: "Jones",
currentState: "proposal"
};
client.folders.addMetadata('11111', client.metadata.scopes.ENTERPRISE, "marketingCollateral", metadataValues)
.then(metadata => {
/* metadata -> {
audience: 'internal',
documentType: 'Q1 plans',
competitiveDocument: 'no',
status: 'active',
author: 'Jones',
currentState: 'proposal',
'$type': 'marketingCollateral-d086c908-2498-4d3e-8a1f-01e82bfc2abe',
'$parent': 'folder_11111',
'$id': '2094c584-68e1-475c-a581-534a4609594e',
'$version': 0,
'$typeVersion': 0,
'$template': 'marketingCollateral',
'$scope': 'enterprise_12345' }
*/
});iOS
let metadata = [
"name": "John Doe",
"birthday": "2000-01-01T00:00:00Z",
"department": "Sales"
]
client.metadata.create(
forFolderWithId: "22222",
scope: "enterprise",
templateKey: "personnelRecord",
keys: metadata
) { (result: Result<MetadataObject, BoxSDKError>) in
guard case let .success(metadata) = result {
print("Error adding metadata")
return
}
print("Successfully attached metadata")
}レスポンスの例
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "marketingCollateral",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}