Get metadata instance on file
Retrieves the instance of a metadata template that has been applied to a file.
Request
Path Parameters
12345The 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.
globalThe scope of the metadata template
Value is one of global,enterprise
propertiesThe name of the metadata template
Response
An instance of the metadata template that includes additional "key:value" pairs defined by the user or an application.
Returned when the request parameters are not valid.
Returned if the metadata template specified was not applied to this file or the user does not have access to the file.
instance_not_found- The metadata template was not applied to the file.
Returned when the method was not allowed.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
-H "authorization: Bearer <ACCESS_TOKEN>"Response Example
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "marketingCollateral",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}