box_metadata_set_instance_on_file_tool
Assign metadata to a file using a specified template. Requires a template key, file ID, and metadata values. Updates file attributes for enhanced organization and retrieval.
Instructions
Set a metadata instance on a file.
Args: ctx (Context): The context object containing the request and lifespan context. template_key (str): The key of the metadata template. file_id (str): The ID of the file to set the metadata on. metadata (dict): The metadata to set. Example: {'test_field': 'Test Value', 'date_field': '2023-10-01T00:00:00.000Z', 'float_field': 3.14, 'enum_field': 'option1', 'multiselect_field': ['option1', 'option2']}
Returns: dict: The response from the Box API after setting the metadata.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_id | Yes | ||
| metadata | Yes | ||
| template_key | Yes |
Input Schema (JSON Schema)
{
"properties": {
"file_id": {
"title": "File Id",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"title": "Metadata",
"type": "object"
},
"template_key": {
"title": "Template Key",
"type": "string"
}
},
"required": [
"template_key",
"file_id",
"metadata"
],
"title": "box_metadata_set_instance_on_file_toolArguments",
"type": "object"
}