CustomFieldReference

Custom fields are user-defined key-value metadata pairs that can be attached to assets and files. The manager user defines the type and shape of the field, and the end users will work with the values. Custom field definitions can be shared between multiple Media Roots

Properties

Name	Type	Description	Notes
id	int
labels	[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]		[optional] [readonly]
options	[str]		[optional] [readonly]
name	str		[optional] [readonly]
order	int		[optional] [readonly]
type	str	The kind of field, which controls its input widget and value format.	[optional] [readonly]
use_for_uploads	bool	Show this field in the upload panel.	[optional] [readonly]
require_to_upload	bool	Require a value for this field when uploading files.	[optional] [readonly]
non_user_editable	bool	Prevent end users from editing this field's value in the UI (the field will only be editable via API and Automation).	[optional] [readonly]
validation	str, none_type	Validation rule applied to values entered for this field.	[optional] [readonly]
regex	str, none_type	Regular expression that values must match (when validation is `regex`).	[optional] [readonly]
range_min	int, none_type	Minimum allowed numeric value (when validation is `range`).	[optional] [readonly]
range_max	int, none_type	Maximum allowed numeric value (when validation is `range`).	[optional] [readonly]
number_of_digits	int, none_type	Required number of digits (when validation is `number_of_digits`).	[optional] [readonly]
metadata_prefill	str, none_type	Name of an embedded metadata field to pre-fill this field's value from.	[optional] [readonly]
highlight_expiration	bool	For date fields, visually highlight assets whose date has passed or is near.	[optional] [readonly]
multiple_response	bool	Allow multiple values to be selected/entered.	[optional] [readonly]
help_text	str, none_type	Help text shown to users filling in this field.	[optional] [readonly]
users_from_group	int, none_type	For user-type fields, restrict selectable users to members of this group.	[optional] [readonly]

[Back to Model list] [Back to API list] [Back to README]