Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Get classification on folder
Retrieves the classification metadata instance that has been applied to a folder.
This API can also be called by including the enterprise ID in the
URL explicitly, for example
/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo.
Request
Path Parameters
12345The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting this folder in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/folder/123
the folder_id is 123.
The root folder of a Box account is
always represented by the ID 0.
Response
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.
Returned when the request parameters are not valid.
Returned if the metadata template specified was not applied to this folder or the user does not have access to the folder.
instance_not_found- The metadata template was not applied to the folder.
Returned when the method was not allowed.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/folders/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.folderClassifications.getClassificationOnFolder(folder.id);client.folder_classifications.get_classification_on_folder(folder.id)await client.FolderClassifications.GetClassificationOnFolderAsync(folderId: folder.Id);try await client.folderClassifications.getClassificationOnFolder(folderId: folder.id)BoxFolder folder = new BoxFolder(api, "id");
Metadata metadata = folder.getMetadata(Metadata.CLASSIFICATION_TEMPLATE_KEY);metadata = client.folder(folder_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').get()var folderId = "0";
var folderMetadata = await client.MetadataManager.GetFolderMetadataAsync(folderId, "enterprise", "securityClassification-6VMVochwUWo");client.folders.getMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo')
.then(metadata => {
// the metadata instance, which includes the applied metadata
});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"
}