Metadata Categories

A MetadataCategory defines a reusable set of Custom Metadata rules that can be assigned to folders via a folder behavior. Each category specifies named metadata keys with optional allowed-value constraints, and a set of default columns to display in the UI.

If a key's allowed_values array is empty, it is treated as a free-form text field. If the array is non-empty, the key is constrained to those values in the Web UI.

List Metadata Categories

SDK Method

files_sdk.metadata_category.list()

Return Object

ListObj[MetadataCategory]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import files_sdk

try:
  metadata_categories = files_sdk.metadata_category.list()
  for metadata_category in metadata_categories.auto_paging_iter():
    # Operate on metadata_category
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Metadata Category

SDK Method

files_sdk.metadata_category.find()

Return Object

MetadataCategory

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Metadata Category ID.

Example Request

import files_sdk

try:
  metadata_category = files_sdk.metadata_category.find(id)
  # Operate on metadata_category
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

List Metadata Categories by Path

SDK Method

files_sdk.metadata_category.list_for()

Return Object

ListObj[MetadataCategory]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
path
string
Required		Path to operate on.

Additional Arguments

Example Request

import files_sdk

try:
  metadata_categories = files_sdk.metadata_category.list_for(path)
  for metadata_category in metadata_categories.auto_paging_iter():
    # Operate on metadata_category
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Metadata Category

SDK Method

files_sdk.metadata_category.create()

Return Object

MetadataCategory

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string
Required		Name of the metadata category.
default_columns
array(string)		Metadata keys that should appear as columns in the UI by default.

Example Request

import files_sdk

try:
  metadata_category = files_sdk.metadata_category.create({
    "name": "Approval Workflow"
  })
  # Operate on metadata_category
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Update Metadata Category

SDK Method

metadata_category.update()

Return Object

MetadataCategory

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Name of the metadata category.
default_columns
array(string)		Metadata keys that should appear as columns in the UI by default.

Example Request

import files_sdk

try:
  # Find the metadata_category object by its id.
  metadata_category = files_sdk.metadata_category.find(id)
  metadata_category.update({
    "name": "Approval Workflow"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Metadata Category

SDK Method

metadata_category.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import files_sdk

try:
  # Find the metadata_category object by its id.
  metadata_category = files_sdk.metadata_category.find(id)
  metadata_category.delete()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The MetadataCategory Object

Some of the methods above return a MetadataCategory object. The attributes of this object are listed below.

AttributeDescription
id
int64		Metadata Category ID
name
string		Name of the metadata category.
definitions
hash(string,array(string))		Map of key names to arrays of allowed values. An empty array means free-form text.
default_columns
array(string)		Metadata keys that should appear as columns in the UI by default.