REST Object Definitions Configuration Related Objects FlexView Object

Flex-Views provide a means to extend the mobile application with additional read-only data fields (Flex-Inputs provide custom input fields). FlexView objects are never used standalone, rather they are always included inside another object which determines where in the application they will be displayed.

Notes:

Multiple Flex-View fields can be grouped together within an optionally titled group
Multiple Flex-View groups can be defined
Flex-Views are unique to the object they are contained in side of. This means each instance of an object (e.g. work order) may have its own unique set of Flex-View fields.

On this page:

FlexView Object Formats

JSON Fomat

{
	"ID": "",
    "Title": "GroupName",
	"Items": [
		{
			"ID": "",
			"Label": "label text",
			"Value": "",
            "Delete": false
		}
	],
    "Delete": false
}

FlexView Object Properties

Required fields are in bold.

Property

Value

Description

ID

string

Optional property.

This property uniquely identifies flex view object.

3.19.1

Title

string

Optional title for a grouped collection of Flex-View fields. If this field is not specified then the grouping will not have a title.

Items

collection

This collection contains multiple Flex-View fields.

Property	Value	Description
ID	string	Optional property. This property uniquely identifies flex view field object. 3.19.1
Label	string	The label of the field.
Text	string	The text to be displayed next to the label. The mobile application will automatically wrap long text fields.
Delete	boolean	Optional property. This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request. 3.19.1

Delete

boolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

3.19.1