Latest version
List all global metadata templates
Used to retrieve all generic, global metadata templates available to all enterprises using Box.
Request
bearer [ACCESS_TOKEN]
application/json
Query Parameters
integer (int64)in queryoptional
10001000The maximum number of items to return per page.
stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiDefines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
This requires usemarker to be set to true.
Response
application/jsonMetadata templates
Returns all of the metadata templates available to all enterprises and their corresponding schema.
application/jsonClient error
Returned when the request parameters are not valid.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/metadata_templates/global" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.metadataTemplates.getGlobalMetadataTemplates();Python Gen
client.metadata_templates.get_global_metadata_templates().NET Gen
await client.MetadataTemplates.GetGlobalMetadataTemplatesAsync();Swift Gen (Beta)
try await client.metadataTemplates.getGlobalMetadataTemplates()Java
Iterable<MetadataTemplate> templates = MetadataTemplate.getEnterpriseMetadataTemplates('global', api);
for (MetadataTemplate templateInfo : templates) {
// Do something with the metadata template.
}Python
templates = client.get_metadata_templates(scope='global)
for template in templates:
print(f'Metadata template {template.templateKey} is in global scope').NET
BoxEnterpriseMetadataTemplateCollection<BoxMetadataTemplate> templates = await client.MetadataManager
.GetEnterpriseMetadataAsync("global");Node
client.metadata.getTemplates('global')
.then(templates => {
// ...
});iOS
let iterator = client.metadata.listEnterpriseTemplates(scope: "global")
iterator.next { results in
switch results {
case let .success(page):
for template in page.entries {
print("Template name: \(template.displayName)")
}
case let .failure(error):
print(error)
}
}Response Example
{
"entries": [
{
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"fields": [
{
"description": "The category",
"displayName": "Category",
"hidden": true,
"key": "category",
"options": [
{
"key": "Category 1",
"id": "45dc2849-a4a7-40a9-a751-4a699a589190"
}
],
"type": "string",
"id": "822227e0-47a5-921b-88a8-494760b2e6d2"
}
],
"hidden": true,
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"scope": "enterprise_123456",
"templateKey": "productInfo",
"type": "metadata_template"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}