folder_metadata.md

FolderMetadataManager

• List metadata instances on folder
• Get metadata instance on folder
• Create metadata instance on folder
• Update metadata instance on folder
• Remove metadata instance from folder

List metadata instances on folder

Retrieves all metadata for a given folder. This can not be used on the root folder with ID 0.

This operation is performed by calling function get_folder_metadata.

See the endpoint docs at API Reference.

client.folder_metadata.get_folder_metadata(folder.id)

Arguments

• folder_id str
  • The 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. Example: "12345"
• view Optional[str]
  • Taxonomy field values are returned in API view by default, meaning the value is represented with a taxonomy node identifier. To retrieve the Hydrated view, where taxonomy values are represented with the full taxonomy node information, set this parameter to hydrated. This is the only supported value for this parameter.
• 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 Metadatas.

Returns all the metadata associated with a folder.

This API does not support pagination and will therefore always return all of the metadata associated to the folder.

Get metadata instance on folder

Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID 0.

This operation is performed by calling function get_folder_metadata_by_id.

See the endpoint docs at API Reference.

client.folder_metadata.get_folder_metadata_by_id(
    folder.id, GetFolderMetadataByIdScope.GLOBAL, "properties"
)

Arguments

• folder_id str
  • The 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. Example: "12345"
• scope GetFolderMetadataByIdScope
  • The scope of the metadata template. Example: "global"
• template_key str
  • The name of the metadata template. Example: "properties"
• 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 MetadataFull.

An instance of the metadata template that includes additional "key:value" pairs defined by the user or an application.

Create metadata instance on folder

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template will be accepted, except for the global.properties template which accepts any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be configured to enable Cascading Folder Level Metadata for the user in the admin console.

This operation is performed by calling function create_folder_metadata_by_id.

See the endpoint docs at API Reference.

client.folder_metadata.create_folder_metadata_by_id(
    folder.id,
    CreateFolderMetadataByIdScope.ENTERPRISE,
    template_key,
    {
        "name": "John",
        "age": 23,
        "birthDate": "2001-01-03T02:20:50.520Z",
        "countryCode": "US",
        "sports": ["basketball", "tennis"],
    },
)

Arguments

• folder_id str
  • The 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. Example: "12345"
• scope CreateFolderMetadataByIdScope
  • The scope of the metadata template. Example: "global"
• template_key str
  • The name of the metadata template. Example: "properties"
• request_body Dict
  • Request body of createFolderMetadataById 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 MetadataFull.

Returns the instance of the template that was applied to the folder, including the data that was applied to the template.

Update metadata instance on folder

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.

This operation is performed by calling function update_folder_metadata_by_id.

See the endpoint docs at API Reference.

client.folder_metadata.update_folder_metadata_by_id(
    folder.id,
    UpdateFolderMetadataByIdScope.ENTERPRISE,
    template_key,
    [
        UpdateFolderMetadataByIdRequestBody(
            op=UpdateFolderMetadataByIdRequestBodyOpField.REPLACE,
            path="/name",
            value="Jack",
        ),
        UpdateFolderMetadataByIdRequestBody(
            op=UpdateFolderMetadataByIdRequestBodyOpField.REPLACE, path="/age", value=24
        ),
        UpdateFolderMetadataByIdRequestBody(
            op=UpdateFolderMetadataByIdRequestBodyOpField.REPLACE,
            path="/birthDate",
            value="2000-01-03T02:20:50.520Z",
        ),
        UpdateFolderMetadataByIdRequestBody(
            op=UpdateFolderMetadataByIdRequestBodyOpField.REPLACE,
            path="/countryCode",
            value="CA",
        ),
        UpdateFolderMetadataByIdRequestBody(
            op=UpdateFolderMetadataByIdRequestBodyOpField.REPLACE,
            path="/sports",
            value=["football"],
        ),
    ],
)

Arguments

• folder_id str
  • The 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. Example: "12345"
• scope UpdateFolderMetadataByIdScope
  • The scope of the metadata template. Example: "global"
• template_key str
  • The name of the metadata template. Example: "properties"
• request_body List[UpdateFolderMetadataByIdRequestBody]
  • Request body of updateFolderMetadataById 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 MetadataFull.

Returns the updated metadata template instance, with the custom template data included.

Remove metadata instance from folder

Deletes a piece of folder metadata.

This operation is performed by calling function delete_folder_metadata_by_id.

See the endpoint docs at API Reference.

client.folder_metadata.delete_folder_metadata_by_id(
    folder.id, DeleteFolderMetadataByIdScope.ENTERPRISE, template_key
)

Arguments

• folder_id str
  • The 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. Example: "12345"
• scope DeleteFolderMetadataByIdScope
  • The scope of the metadata template. Example: "global"
• template_key str
  • The name of the metadata template. Example: "properties"
• 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 metadata is successfully deleted.