List metadata query indices
Retrieves the metadata query indices for a given scope and template key.
Request
bearer [ACCESS_TOKEN]
application/json
Query Parameters
stringin queryrequired
"global"The scope of the metadata template
Value is one of global,enterprise
stringin queryrequired
"properties"The name of the metadata template
Response
application/jsonMetadata query indices
Returns a collection of metadata query indices for scope and template key.
application/jsonClient error
Returns an error when any of the parameters are not in a valid format.
application/jsonClient error
Returns an error when the scope and template combination cannot be found.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/metadata_query_indices?scope=enterprise&template_key=properties" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript (Beta)
await client.search.getMetadataQueryIndices({
scope: 'enterprise' as GetMetadataQueryIndicesQueryParamsArgScopeField,
templateKey: templateKey,
} satisfies GetMetadataQueryIndicesQueryParamsArg);Python (Beta)
client.search.get_metadata_query_indices(scope=GetMetadataQueryIndicesScopeArg.ENTERPRISE.value, template_key=template_key)Response Example
{
"entries": [
{
"id": "-9876",
"type": "metadata_query_index",
"status": "active",
"fields": [
{
"key": "vendor name",
"sort_direction": "asc"
}
]
}
],
"limit": 100,
"next_marker": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.."
}