API - Planyo Web Services - get_custom_property_definition

Sie sind hier: Planyo » Hilfe » API » get_custom_property_definition

get_custom_property_definition (version 1)

Description:

Use this function to retrieve details of a custom resource property or a custom site property (metasites only).

Input:

name string required
Custom property name
scope string optional
One of 'resource', 'site'. Default is 'resource'. This determines whether the custom property definition is for resource properties or site properties. The value 'site' is used only by metasites.
version float optional
you can optionally specify the version of the API that you're using. Use the value of latest or simply skip this parameter to use the latest API version. The latest version is: 1
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

name string
Property name
translated_name string
If language is passed and a translation is found for this language, the translated version will be returned here
type string
Property type. One of: 'text', 'dropdown', 'checkbox', 'textarea', 'multiple_checkboxes', 'gps', 'persons', 'url', 'tax_rate'. These correspond to the property types found in the backend UI.
possible_values string
In case of the 'dropdown' type, these are the comma-separated possible values.
translated_values string
If language is passed and a translation is found for this language, the translated version will be returned here
search_condition string
Search criterium: 'eq': search finds only the exact value, 'gte': for numeric values it's the >= operator, 'gt': numeric >, 'lte': numeric <=, 'lt': numeric <, 'mv_': in search presented as multiple checkboxes (at least one must match), 'm2_': in search presented as multiple checkboxes (all must match), 'cnt': (for text values) value must contain text specified in search box, 'chk': chosen if type is 'checkbox'
priority int
Property priority (determines the ordering when presenting all resource properties)
comment string
Comment.

API playground:

Click here to test this function in the API playground.