getmetadata
Getmetadata returns a list of fields and their properties (in Axiell AdlibXML format) from a database.
Syntax
command=getmetadata&<parameter>=<value>&...
-
database
(String)
database from which to retrieve the metadata. The name of this database must have been specified in the adlibweb.xml file.
-
fields
(String)
[optional] list of comma separated field names for which to retrieve the metadata. A wildcard (*, may replace multiple characters) is allowed in any position in the fieldname. You can only access fields which are specified in the adlibweb.xml file.
-
output
(String)
[optional] output format to be returned. Values for
output
can be either json
or xml
(xml
is the default, so you don't need to specify that explicitly). However, the output format produced by jQuery applications is always JSON, so you don't need to specify the output type there either.
Read more about JSON output here.
-
callback
(String)
[optional] returns JSON output wrapped in brackets with your callback function name, for AJAX requests: <callback function name>( <JSON output> ); You don't need to specify
output=json
, because the output format is JSON by default.
Description
The returned metadata comprises the field tag (case-sensitive), the field name (possibly in several translations), the field's display name (possibly in several translations, the field length in bytes, the data type of the field, the name of any field group the field might be part of, the repeatability of the field (True or False), whether the field is linked or not (True or False), and whether the field is indexed or not (True or False). From WebAPI 3.0.20198.1, the isMultiLingual and isInherited properties are included as well, since for secondary or third party software using the WebAPI to write data it is important to know if a field is multilingual or not, because they can corrupt the data if they write non-multilingual data in a multilingual field. And inherited fields shouldn’t usually be written to because they already get their data for display from a parent record dynamically.
Examples
Description
- no Adlib.Data-specific description available yet; see the URL request tab for all information -
Examples
Description
- no jQuery-specific description available yet; see the URL request tab for all information -
Examples