Join BoxWorks 2024 to discover what's possible with content and AI!

Get metadata cascade policy

get

https://api.box.com/2.0

/metadata_cascade_policies/:metadata_cascade_policy_id

Retrieve a specific metadata cascade policy assigned to a folder.

Related Guides

Metadata Get a metadata cascade policy

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Path Parameters

metadata_cascade_policy_id stringin pathrequired

example6fd4ff89-8fc1-42cf-8b29-1890dedd26d7

The ID of the metadata cascade policy.

Response

200application/jsonMetadata cascade policy

Returns a metadata cascade policy

404application/jsonClient error

Returns an error when the policy can not be found or the user does not have access to the folder.

instance_not_found - The policy could not be found
not_found - The folder could not be found or the user does not have access to the folder.

defaultapplication/jsonClient error

An unexpected client error.

get

Get metadata cascade policy

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X GET "https://api.box.com/2.0/metadata_cascade_policies/324324" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.metadataCascadePolicies.getMetadataCascadePolicyById(
  cascadePolicyId,
);

Python Gen

client.metadata_cascade_policies.get_metadata_cascade_policy_by_id(cascade_policy_id)

.NET Gen

await client.MetadataCascadePolicies.GetMetadataCascadePolicyByIdAsync(metadataCascadePolicyId: cascadePolicyId);

Swift Gen (Beta)

try await client.metadataCascadePolicies.getMetadataCascadePolicyById(metadataCascadePolicyId: cascadePolicyId)

Java

String cascadePolicyID = "1234";
BoxMetadataCascadePolicy metadataCascadePolicy = new BoxMetadataCascadePolicy(api, cascadePolicyID);
BoxMetadataCascadePolicy.Info metadataCascadePolicyInfo = metadataCascadePolicy.getInfo();

Python

cascade_policy = client.metadata_cascade_policy('84113349-794d-445c-b93c-d8481b223434').get()
print(f'Cascade policy applies to a template owned by enterprise {cascade_policy.owner_enterprise.id}')

.NET

BoxMetadataCascadePolicy retrievedCascadePolicy = await client.MetadataCascadePolicyManager
    .GetCascadePolicyAsync("12345", IEnumerable<string> fields = null);

Node

var policyID = '84113349-794d-445c-b93c-d8481b223434';
client.metadata.getCascadePolicy(policyID)
	.then(cascadePolicy => {
		/* cascadePolicy -> {
			id: '84113349-794d-445c-b93c-d8481b223434',
			type: 'metadata_cascade_policy',
			owner_enterprise: {
				type: 'enterprise',
				id: '11111'
			},
			parent: {
				type: 'folder',
				id: '22222'
			},
			scope: 'enterprise_11111',
			templateKey: 'testTemplate'
		}
		*/
	});

Response Example

{
  "id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
  "type": "metadata_cascade_policy",
  "owner_enterprise": {
    "id": "690678",
    "type": "enterprise"
  },
  "parent": {
    "id": "1234567",
    "type": "folder"
  },
  "scope": "enterprise_123456",
  "templateKey": "productInfo"
}