最新バ ージョン
ファイルの分類を更新
APIバージョン 2024.0
ファイルの分類を更新します。
分類を更新できるのは、分類がすでにファイルに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。
リクエスト
bearer [ACCESS_TOKEN]
application/json-patch+json
パスパラメータ
stringパス内必須
12345ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。
リクエスト本文
object array本文内必須
分類ラベルを更新するために加える1つの変更を含むリスト。
string本文内必須
"replace" 値は常にreplaceになります。
次の値に固定: replace
string本文内必須
"/Box__Security__Classification__Key"企業で使用できる分類を定義します。
次の値に固定: /Box__Security__Classification__Key
string本文内必須
"Sensitive"このファイルに適用する分類の名前。
会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示 される分類テンプレートを取得します。
リクエストの例
cURL
curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json-patch+json" \
-d '[{
"op": "replace",
"path": "/Box__Security__Classification__Key",
"value": "Internal"
}]'TypeScript Gen
await client.fileClassifications.updateClassificationOnFile(file.id, [
new UpdateClassificationOnFileRequestBody({
value: secondClassification.key,
}),
]);Python Gen
client.file_classifications.update_classification_on_file(
file.id, [UpdateClassificationOnFileRequestBody(value=second_classification.key)]
).NET Gen
await client.FileClassifications.UpdateClassificationOnFileAsync(fileId: file.Id, requestBody: Array.AsReadOnly(new [] {new UpdateClassificationOnFileRequestBody(value: secondClassification.Key)}));Java
BoxFile file = new BoxFile(api, "id");
Metadata metadata = new Metadata()
metadata.add(Metadata.CLASSIFICATION_KEY, "Sensitive")
file.setMetadata(Metadata.CLASSIFICATION_TEMPLATE_KEY, Metadata.ENTERPRISE_METADATA_SCOPE, metadata);Python
classification = {
'Box__Security__Classification__Key': 'Sensitive',
}
applied_metadata = client.file(file_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').set(classification).NET
var fileId = "0";
var update = new BoxMetadataUpdate
{
Op = MetadataUpdateOp.replace,
Path = "/Box_Security_Classification_Key",
Value = "Very Sensitive"
};
var classificationData = await client.MetadataManager
.UpdateFileMetadataAsync(fileId, new List<BoxMetadataUpdate>() { update }, "enterprise", "securityClassification-6VMVochwUWo");Node
var classification = {
Box__Security__Classification__Key: "Sensitive"
};
client.files.addMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo', classification)
.then(metadata => {
// the updated classification applied to the file
});レスポンスの例
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}