Box Developer Documentation
Log in
Latest version

Get metadata cascade policy

get
https://api.box.com/2.0
/metadata_cascade_policies/:metadata_cascade_policy_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieve a specific metadata cascade policy assigned to a folder.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
6fd4ff89-8fc1-42cf-8b29-1890dedd26d7

The ID of the metadata cascade policy.

Response

application/jsonMetadata cascade policy

Returns a metadata cascade policy.

application/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.
application/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.
Log in

Request Example

Learn more about Box SDK versionig strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/metadata_cascade_policies/324324" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.metadataCascadePolicies.getMetadataCascadePolicyById(
  cascadePolicyId,
);
Python v10
client.metadata_cascade_policies.get_metadata_cascade_policy_by_id(cascade_policy_id)
.NET v10
await client.MetadataCascadePolicies.GetMetadataCascadePolicyByIdAsync(metadataCascadePolicyId: cascadePolicyId);
Swift v10
try await client.metadataCascadePolicies.getMetadataCascadePolicyById(metadataCascadePolicyId: cascadePolicyId)
Java v10
client.getMetadataCascadePolicies().getMetadataCascadePolicyById(cascadePolicyId)
Java v4
String cascadePolicyID = "1234";
BoxMetadataCascadePolicy metadataCascadePolicy = new BoxMetadataCascadePolicy(api, cascadePolicyID);
BoxMetadataCascadePolicy.Info metadataCascadePolicyInfo = metadataCascadePolicy.getInfo();
Python v3
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 v5
BoxMetadataCascadePolicy retrievedCascadePolicy = await client.MetadataCascadePolicyManager
    .GetCascadePolicyAsync("12345", IEnumerable<string> fields = null);
Node v3
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"
}