Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Add classification
Adds one or more new classifications to the list of classifications available to the enterprise.
This API can also be called by including the enterprise ID in the
URL explicitly, for example
/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.
Request
Request Body
An array that contains one or more classifications to add to the enterprise's list of classifications.
The details of the classification to add.
"Sensitive"The label of the classification as shown in the web and mobile interfaces. This is the only field required to add a classification.
A static configuration for the classification.
Additional details for the classification.
"Box__Security__Classification__Key"Defines classifications available in the enterprise.
Value is always Box__Security__Classification__Key
"addEnumOption"The type of change to perform on the classification object.
Value is always addEnumOption
Response
Returns the updated securityClassification metadata template, which
contains a Box__Security__Classification__Key field that lists all
the classifications available to this enterprise.
Returned if any of the request parameters are not valid.
Returned when a template name is not correct. Please make sure the URL for the request is correct.
An unexpected client error.
Request Example
curl -i -X PUT "https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json-patch+json" \
-d '[{
"op": "addEnumOption",
"fieldKey": "Box__Security__Classification__Key",
"data": {
"key": "Sensitive",
"staticConfig":{
"classification": {
"classificationDefinition": "Sensitive information that must not be shared.",
"colorID": 4
}
}
}
}]'List<MetadataTemplate.FieldOperation> updates = new ArrayList<MetadataTemplate.FieldOperation>();
String update = "{\n op: \"addEnumOption\",\n fieldKey: \"Box__Security__Classification__Key\",\n data: {\n key: \"Sensitive\"\n }\n}";
updates.add(new MetadataTemplate.FieldOperation(addCategoryFieldJSON));
MetadataTemplate.updateMetadataTemplate(api, Metadata.ENTERPRISE_METADATA_SCOPE, Metadata.CLASSIFICATION_TEMPLATE_KEY, updates);template = client.metadata_template('enterprise', 'securityClassification-6VMVochwUWo')
new_updates = template.start_update()
new_updates.add_enum_option('Box__Security__Classification__Key', 'Sensitive')
updated_template = template.update_info(updates=new_updates)var update = new BoxMetadataTemplateUpdate
{
Op = MetadataTemplateUpdateOp.addEnumOption,
FieldKey = "Box_Security_Classification_Key",
Data = new
{
key = "Sensitive"
}
};
var template = await client.MetadataManager
.UpdateMetadataTemplate(new List<BoxMetadataTemplateUpdate>() { update }, "enterprise", "securityClassification-6VMVochwUWo");var operations = [{
op: "addEnumOption",
fieldKey: "Box__Security__Classification__Key",
data: {
key: "Sensitive",
classification: {
classificationDefinition: "Sensitive information that must not be shared.",
colorID: 4
}
}
}];
client.metadata.updateTemplate('enterprise', 'securityClassification-6VMVochwUWo', operations)
.then(template => {
// the updated classification template
});Response Example
{
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"type": "metadata_template",
"copyInstanceOnItemCopy": true,
"displayName": "Classification",
"fields": [
{
"id": "822227e0-47a5-921b-88a8-494760b2e6d2",
"type": "enum",
"key": "Box__Security__Classification__Key",
"displayName": "Classification",
"hidden": false,
"options": [
{
"id": "46aea176-3483-4431-856c-6b5b13d1cc50",
"key": "Sensitive",
"staticConfig": {
"classification": {
"classificationDefinition": "Sensitive information",
"colorID": 4
}
}
}
]
}
],
"hidden": false,
"scope": "enterprise_123456",
"templateKey": "securityClassification-6VMVochwUWo"
}