Skip to content

Latest commit

 

History

History
148 lines (93 loc) · 5.73 KB

classifications.md

File metadata and controls

148 lines (93 loc) · 5.73 KB

ClassificationsManager

List all classifications

Retrieves the classification metadata template and lists all the classifications available to this 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.

This operation is performed by calling function getClassificationTemplate.

See the endpoint docs at API Reference.

client.getClassifications().getClassificationTemplate()

Arguments

  • headers GetClassificationTemplateHeaders
    • Headers of getClassificationTemplate method

Returns

This function returns a value of type ClassificationTemplate.

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

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.

This operation is performed by calling function addClassification.

See the endpoint docs at API Reference.

client.getClassifications().addClassification(Arrays.asList(new AddClassificationRequestBody(new AddClassificationRequestBodyDataField.AddClassificationRequestBodyDataFieldBuilder(getUuid()).staticConfig(new AddClassificationRequestBodyDataStaticConfigField.AddClassificationRequestBodyDataStaticConfigFieldBuilder().classification(new AddClassificationRequestBodyDataStaticConfigClassificationField.AddClassificationRequestBodyDataStaticConfigClassificationFieldBuilder().classificationDefinition("Other description").colorId(4L).build()).build()).build())))

Arguments

  • requestBody List<AddClassificationRequestBody>
    • Request body of addClassification method
  • headers AddClassificationHeaders
    • Headers of addClassification method

Returns

This function returns a value of type ClassificationTemplate.

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

Update classification

Updates the labels and descriptions of one or more 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.

This operation is performed by calling function updateClassification.

See the endpoint docs at API Reference.

client.getClassifications().updateClassification(Arrays.asList(new UpdateClassificationRequestBody(classification.getKey(), new UpdateClassificationRequestBodyDataField.UpdateClassificationRequestBodyDataFieldBuilder(updatedClassificationName).staticConfig(new UpdateClassificationRequestBodyDataStaticConfigField.UpdateClassificationRequestBodyDataStaticConfigFieldBuilder().classification(new UpdateClassificationRequestBodyDataStaticConfigClassificationField.UpdateClassificationRequestBodyDataStaticConfigClassificationFieldBuilder().classificationDefinition(updatedClassificationDescription).colorId(2L).build()).build()).build())))

Arguments

  • requestBody List<UpdateClassificationRequestBody>
    • Request body of updateClassification method
  • headers UpdateClassificationHeaders
    • Headers of updateClassification method

Returns

This function returns a value of type ClassificationTemplate.

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

Add initial classifications

When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications.

If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

This operation is performed by calling function createClassificationTemplate.

See the endpoint docs at API Reference.

Currently we don't have an example for calling createClassificationTemplate in integration tests

Arguments

  • requestBody CreateClassificationTemplateRequestBody
    • Request body of createClassificationTemplate method
  • headers CreateClassificationTemplateHeaders
    • Headers of createClassificationTemplate method

Returns

This function returns a value of type ClassificationTemplate.

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