Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Add classification to file
Adds a classification to a file by specifying the label of the classification to add.
This API can also be called by including the enterprise ID in the
URL explicitly, for example
/files/:id//enterprise_12345/securityClassification-6VMVochwUWo.
Request
Path Parameters
12345The unique identifier that represents a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
Request Body
"Sensitive"The name of the classification to apply to this file.
To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.
Response
Returns the classification template instance that was applied to the file.
Returns an error when the request body is not valid.
schema_validation_failed- The request body contains a value for a field that either does not exist, or for which the value or type does not match the expected field type. An example might be an unknown option for anenumormultiSelectfield.
Returns an error when the file or metadata template was not found.
not_found- The file could not be found, or the user does not have access to the file.instance_tuple_not_found- The metadata template was not found.
Returns an error when an instance of this metadata template is already present on the file.
tuple_already_exists- An instance of them metadata template already exists on the file.
An unexpected client error.
Request Example
curl -i -X POST "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"Box__Security__Classification__Key": "Sensitive"
}'await client.fileClassifications.addClassificationToFile(file.id, {
requestBody: {
boxSecurityClassificationKey: classification.key,
} satisfies AddClassificationToFileRequestBody,
} satisfies AddClassificationToFileOptionalsInput);client.file_classifications.add_classification_to_file(
file.id, box_security_classification_key=classification.key
)await client.FileClassifications.AddClassificationToFileAsync(fileId: file.Id, requestBody: new AddClassificationToFileRequestBody() { BoxSecurityClassificationKey = classification.Key });try await client.fileClassifications.addClassificationToFile(fileId: file.id, requestBody: AddClassificationToFileRequestBody(boxSecurityClassificationKey: classification.key))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);classification = {
'Box__Security__Classification__Key': 'Sensitive',
}
applied_metadata = client.file(file_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').set(classification)var fileId = "0";
var classification = new Dictionary<string, object>
{
{ "Box_Security_Classification_Key", "Sensitive" }
};
var classificationData = await client.MetadataManager.SetFileMetadataAsync(fileId, classification, "enterprise", "securityClassification-6VMVochwUWo");var classification = {
Box__Security__Classification__Key: "Sensitive"
};
client.files.addMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo', classification)
.then(metadata => {
// the classification applied to the file
});Response Example
{
"$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"
}