Field Configuration

Resource type: fields

With this call a list of the fields created in onOffice, their types and their permitted values can be queried. Depending on the parameters, the corresponding labels from the GUI can also be retrieved in the specified language.

It is important to keep the output in a cache, as the call may take several seconds, depending on the language selected.

Parameters:

  • labels
    Determines if labels are included. BOOLEAN. OPTIONAL.
  • language
    Language in three capital letters according to ISO 3166-1 alpha-3. STRING. OPTIONAL.
  • fieldList
    Only the fields specified here are output. ARRAY. OPTIONAL.
  • modules
    Only the fields of the modules specified here are output. The most important module IDs are: address, estate, agentsLog, calendar, email, estate, news, intranet, project, task, user. ARRAY. OPTIONAL.
  • showOnlyInactive
    Only inactive fields are displayed. BOOLEAN. OPTIONAL.

  • If you do not specify a parameter, the entire field list including all information is output.

Example:

...
"actions":[
    {
        "actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid":"",
        "identifier":"",
        "resourcetype":"fields",
        "identifier":"",
        "parameters": {
                "labels":true,
                "language":"DEU",
                "modules":["address", "estate"]
        }
    }
]
...

Response:

The module is always specified as the record ID. Under “elements” the label of the respective module can be found (if labels is set), as well as the respective fields:

  • the field name as a key,
  • type
    Specification of the type (singleselect, multiselect, freetext)
  • permittedvalues
    Permitted values (only relevant for singleselect and multiselect fields)
  • default
    Default value of the field
  • compoundField
    Array of fields that make up the composite field. E.g. the field Plz-Ort is composed of postcode (Plz) and city (Ort). A compound field is set by setting the individual fields.
  • label
    Field name in the GUI in the selected language
...
"actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:get",
	"resourceid":"",
	"resourcetype":"fields",
	"identifier":"",
	"data":{
		"meta":{
			"cntabsolute":null
		},
		"records":[
			{
				"id":"address",
				"type":"",
				"elements":{
					"gwgMitgliederVerwaltungsorgan":{
						"type":"freetext",
						"permittedvalues":[],
						"default":null
						},
					"schaufensterTv_veroeffentlichen":{
						"type":"freetext",
						"permittedvalues":[],
						"default":null
					},
...

The query for the fields Aktionsart (kind of action) and Aktionstyp (type of action) is an exception: Aktionsart is displayed as a singleselect and Aktionstyp as freetext. These two fields are handled differently internally and must be queried via a separate action.

Kind of action und type of action