get_resource_type_fields

Get metadata field information for all (matching) fields.

Available from version 10.3+.

Requires permission a.

Variable Description Data type Default
$by_resource_types Filter result by resource type. If multiple, use a CSV of resource types. string ''
$find Filter result by fuzzy searching in different properties (e.g name, title, ref, help text etc) string ''
$by_types Filter result by field type (FIELD_TYPE_* constants). If multiple, use a CSV of field types. string ''

Response

Returns the matching fields' information or 403 HTTP status if not authorised.

Examples

[{"ref":18,"name":"caption","title":"Caption","field_constraint":null,"type":1,"order_by":280,"keywords_index":1,"partial_index":0,"global":1,"resource_column":null,"display_field":1,"use_for_similar":0,"iptc_equiv":"2#120","display_template":null,"required":0,"smart_theme_name":null,"exiftool_field":"Caption-Abstract,Description,ImageDescription","advanced_search":1,"simple_search":0,"help_text":null,"display_as_dropdown":0,"external_user_access":1,"autocomplete_macro":null,"hide_when_uploading":0,"hide_when_restricted":0,"value_filter":null,"exiftool_filter":null,"omit_when_copying":0,"tooltip_text":null,"regexp_filter":null,"sync_field":null,"display_condition":null,"onchange_macro":null,"linked_data_field":null,"automatic_nodes_ordering":0,"fits_field":null,"personal_data":0,"include_in_csv_export":1,"browse_bar":1,"read_only":0,"active":1,"full_width":1,"tab":null,"tab_name":null,"resource_types":null}]