REST Object Definitions Configuration Related Objects FlexAttr Object

FlexAttr Object Formats

JSON Format

{
	"Default": "",
    "Desc": {
        "en": "English description",
        "es": "Spanish description"
    },
    "FlexAttrID": "",
    "InputType": 1001,
    "IsActive" : true,
    "IsReq": false,
    "Label": {
        "en": "English label",
        "es": "Spanish label"
    },
    "Max": 0.0,
    "Min": 0.0,
    "Precision": 0,
    "Rules": "",
    "Selections": [
        {
            "Code" : "",
            "Text": {
                "en": "English label",
                "es": "Spanish label"
            },
        }
    ]
}

FlexAttr Object Properties

Required properties are in bold.

Property Type Description

Default string Specifies the default value for the field. If set, this value will be pre-populate on the mobile device.

Desc

object

This property contains a list of descriptions of the flex attribute for each required language. Each member pair consists of the language identifier (left side) and the text for the language (right side).

FlexAttrID

ID

string

The unique identifier associated with this flex attribute definition.

This is a customer defined value and as such the customer must maintain uniqueness. If a flex attribute ID is reused it essentially overwrites the existing definition with the same ID.

InputType

string

Identifies the type of input field for the FlexAttr.

Valid values are:

1001 = String
1002 = Decimal
1003 = Integer
1004 = Date
1005 = Time
1006 = Date and time
1008 = Notes
1010 = Checkbox
2001 = Single Selection List
2002 = Multi-Selection List
2003 = Yes/No Selection List

IsActive

boolean

Identifies if this flex attribute definition is active. If true, then the mobile application will continue to allow the data to be collected. If false, the definition will remain for historical reporting however, the mobile application will no longer prompt to collect the data.

Valid values are:

true = The flex attribute definition is active
false = The flex attribute definition is not active

IsReq

boolean

Identifies if this FlexAttr is required to be filled in.

Valid values are:

false = The flex attribute is optional and is not required to be filled in. This is the default value if the property is missing.
true = The flex attribute is required and must be filled in.

Label object This object contains the label text for one or more languages. Each member pair within the object defines one language where the left side specifies the language code and the right side of the pair contains the label text for the language.

Max decimal Identifies the maximum value that can be entered for the custom field. If this property if not specified then no maximum value will be enforced.

Min decimal Identifies the minimum value that can be entered for the custom field. If this property is not specified then no minimum value will be enforced.

Precision integer Identified the maximum precision length for decimal custom field. If this property if not specified then no precision will be enforced.

Rules object Rules will be implemented in a future release.

Selections

collection

This object contains a collection of selection choices when the InputType is 2001. Each selection contains an internal, customer defined, code and one or more localized text descriptions.

Property

Type

Description

Code

string

This is the value that will be saved when the item is selected. This is a customer defined value.

Text

object

This object contains the localized text for the section option.

Each property defined in this Text object defines one localized text entry with the property name set to the language code and the value of the property set to the localized text for the language.