Collection

An object

Specification

spec

• Type: Array

• Description of the collection.

• Array of parameters. Standard parameters syntax is used.

{
    "name": "myCollection",
    "type": "collection",
    "label": "My Collection",
    "spec": [
        {
            "name": "email",
            "type": "email"
        },
        {
            "name": "phone",
            "type": "text"
        }
    ]
}

sequence

• Type: Boolean

• If set to true , all properties of the object will be in the same order as they are defined in the spec.

Examples

Simple Collection

You can easily create a collection by specifying its parameters in the spec.

Appearance

Example of Simple Collection

Source

[
	{
		"name": "contact",
		"spec": [
			{
				"name": "firstname",
				"type": "text",
				"label": "First name"
			},
			{
				"name": "lastname",
				"type": "text",
				"label": "Last name"
			}
		],
		"type": "collection",
		"label": "Contact"
	}
]

Output

{
    "lastname": "Doe",
    "firstname": "John"
}

Collection in a Collection

Collections can be also nested in another collection.

Appearance

Example of Collection in Collection

Source

[
	{
		"name": "contact",
		"spec": [
			{
				"name": "firstname",
				"type": "text",
				"label": "First name"
			},
			{
				"name": "lastname",
				"type": "text",
				"label": "Last name"
			},
			{
				"name": "address",
				"label": "Address",
				"type": "collection",
				"spec": [
					{
						"label": "Street",
						"name": "street",
						"type": "text"
					},
					{
						"label": "City",
						"name": "city",
						"type": "text"
					}
				]
			}
		],
		"type": "collection",
		"label": "Contact"
	}
]

Output

{
    "address": {
        "city": "Prague",
        "street": "Novakovych"
    },
    "lastname": "Doe",
    "firstname": "John"
}