Resource type: searchCriteriaFields
With this API call all fields can be queried that are marked / selected as search criteria.
Parameters:
- (none)
Request example
{ "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get", "resourceid": "", "identifier": "", "resourcetype": "searchCriteriaFields", "parameters": [] }
Response:
name
Name of the categoryfields
Array of JSON objects. List of fields in a category.id
Unique field keyname
name of fieldposition
Position of the field within the search criteria fieldstype
Type of field (data type,singleselect
,multiselect
)
Special case “regionaler_zusatz” (Regional addition):limitExceeded
,displayAll
,displayLive
ko
OPTIONAL. Field is marked as knockout criterionmandatory
OPTIONAL. Field is a mandatory fieldrangefield
OPTIONAL. Field has a value range (“from” – “to” field)objektarten
OPTIONAL. Field filter for property classes. Comma-separated “list” of the property classes for which the field is to be displayednutzungsarten
OPTIONAL. Field filter for type of usage. Comma-separated “list” of the types of usage for which the field is to be displayedvermarktungsarten
OPTIONAL. Field filter for marketing method. Comma-separated “list” of marketing methods for which the field is to be displayedvalues
OPTIONAL. Only for typesingle-
andmultiselect
. JSON object with individual key-value pairsdefault
OPTIONAL. Only for typesingle-
undmultiselect
. Default value of the singleselect or multiselect values
Beispiel:
... elements: { name: "Flächen", fields: [ { id: "wohnflaeche", name: "Wohnfläche", position: "3", ko: "true", rangefield: "true", type: "urn:onoffice-de-ns:smart:2.5:dbAccess:dataType:float", objektarten: "wohnung,haus,waz,hallen_lager_prod,zimmer" }, ...