Skip to content

file_classifications.md

Latest commit

 

History

History
149 lines (100 loc) · 5.77 KB

file_classifications.md

File metadata and controls

149 lines (100 loc) · 5.77 KB

FileClassificationsManager

Get classification on file

Retrieves the classification metadata instance that has been applied to a file.

This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation is performed by calling function get_classification_on_file.

See the endpoint docs at API Reference.

client.file_classifications.get_classification_on_file(file.id)

Arguments

  • file_id str
    • The 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. Example: "12345"
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type Classification.

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

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.

This operation is performed by calling function add_classification_to_file.

See the endpoint docs at API Reference.

client.file_classifications.add_classification_to_file(
    file.id, box_security_classification_key=classification.key
)

Arguments

  • file_id str
    • The 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. Example: "12345"
  • box_security_classification_key Optional[str]
    • 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.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type Classification.

Returns the classification template instance that was applied to the file.

Update classification on file

Updates a classification on a file.

The classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted.

This operation is performed by calling function update_classification_on_file.

See the endpoint docs at API Reference.

client.file_classifications.update_classification_on_file(
    file.id, [UpdateClassificationOnFileRequestBody(value=second_classification.key)]
)

Arguments

  • file_id str
    • The 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. Example: "12345"
  • request_body List[UpdateClassificationOnFileRequestBody]
    • Request body of updateClassificationOnFile method
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type Classification.

Returns the updated classification metadata template instance.

Remove classification from file

Removes any classifications from a file.

This API can also be called by including the enterprise ID in the URL explicitly, for example /files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

This operation is performed by calling function delete_classification_from_file.

See the endpoint docs at API Reference.

client.file_classifications.delete_classification_from_file(file.id)

Arguments

  • file_id str
    • The 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. Example: "12345"
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type None.

Returns an empty response when the classification is successfully deleted.