Join the first BoxWorks Hackathon for Good - customers, partners, and the developer community are welcome to participate in the 48 hour Hack to benefit The Nature Conservancy.

Delete classification

put

https://api.box.com/2.0

/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

Removes a classification from 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.

Related Guides

Metadata Classifications

Request

AuthorizationBearer [ACCESS_TOKEN]

Content-Typeapplication/json-patch+json

Request Body

<item> object arrayin bodyrequired

An array that contains one or more classifications to remove.

[<item>].enumOptionKey stringin bodyrequired

exampleSensitive

The label of the classification to remove.

[<item>].fieldKey stringin bodyrequired

exampleBox__Security__Classification__Key

Box__Security__Classification__Key

[<item>].op stringin bodyrequired

exampleremoveEnumOption

removeEnumOption

Response

200application/jsonClassification Template

Returns the updated securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

400application/jsonClient error

Returned if any of the request parameters are not valid.

404application/jsonClient error

Returned when a template name is not correct. Please make sure the URL for the request is correct.

defaultapplication/jsonClient error

An unexpected client error.

put

Delete classification

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

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": "removeEnumOption",
       "fieldKey": "Box__Security__Classification__Key",
       "enumOptionKey": "Sensitive"
     }]'

.NET

var update = new BoxMetadataTemplateUpdate
{
    Op = MetadataTemplateUpdateOp.removeEnumOption,
    FieldKey = "Box_Security_Classification_Key",
    EnumOptionKey = "Sensitive",
};

var template = await client.MetadataManager
    .UpdateMetadataTemplate(new List<BoxMetadataTemplateUpdate>() { update }, "enterprise", "securityClassification-6VMVochwUWo");

Java

List<MetadataTemplate.FieldOperation> updates = new ArrayList<MetadataTemplate.FieldOperation>();

String update = "{\n  op: \"removeEnumOption\",\n  fieldKey: \"Box__Security__Classification__Key\",\n  enumOptionKey: \"Sensitive\"\n}";

updates.add(new MetadataTemplate.FieldOperation(addCategoryFieldJSON));

MetadataTemplate.updateMetadataTemplate(api, Metadata.ENTERPRISE_METADATA_SCOPE, Metadata.CLASSIFICATION_TEMPLATE_KEY, updates);

Python

template = client.metadata_template('enterprise', 'securityClassification-6VMVochwUWo')
new_updates = template.start_update()
new_updates.remove_enum_option('Box__Security__Classification__Key', 'Sensitive')
updated_template = template.update_info(updates=new_updates)

Node

var operations = [{
  op: "removeEnumOption",
  fieldKey: "Box__Security__Classification__Key",
  enumOptionKey: "Sensitive"
}];
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"
}