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::MetadataCategory.list

Return Object

List<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

begin
  metadata_categories = Files::MetadataCategory.list
  metadata_categories.auto_paging_each do |metadata_category|
    # Operate on metadata_category
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Metadata Category

SDK Method

Files::MetadataCategory.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

begin
  metadata_category = Files::MetadataCategory.find(id)
  # Operate on metadata_category
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

List Metadata Categories by Path

SDK Method

Files::MetadataCategory.list_for

Return Object

List<MetadataCategory>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
path
string
Required		Path to operate on.

Additional Arguments

Example Request

begin
  metadata_categories = Files::MetadataCategory.list_for(path)
  metadata_categories.auto_paging_each do |metadata_category|
    # Operate on metadata_category
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Metadata Category

SDK Method

Files::MetadataCategory.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

begin
  metadata_category = Files::MetadataCategory.create(
    name: "Approval Workflow"
  )
  # Operate on metadata_category
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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

begin
  # Find the metadata_category object by its id.
  metadata_category = Files::MetadataCategory.find(id)
  metadata_category.update(
    name: "Approval Workflow"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Metadata Category

SDK Method

metadata_category.delete

Return Object

nil

Authorization Requirement

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

Example Request

begin
  # Find the metadata_category object by its id.
  metadata_category = Files::MetadataCategory.find(id)
  metadata_category.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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.