Definitions - Basics

[
    {
        "filter": {
            "links": [
                {
                    "matches": "owners",
                    "ownerType": "Asset",
                    "attributes": [
                        {
                            "attribute": "id",
                            "operator": "equals",
                            "values": [
                                "df5c9561-0a76-49ac-8bc5-e5d76c545a4a"
                            ]
                        },
                        {
                            "attribute": "externalId",
                            "operator": "equals",
                            "values": [
                                "dsmrAC67B23BFA7C"
                            ]
                        }
                    ]
                }
            ]
        } 
    }
]

{
      "id": "businessType",
      "label": "Rechtsvorm",
      "type": "enum",
      "options": [
        {
          "id": "BESLOTEN_VENNOOTSCHAP",
          "name": "B.V."
        },
        {
          "id": "NAAMLOZE_VENNOOTSCHAP",
          "name": "N.V."
        },
        {
          "id": "VERENIGING_VAN_EIGENAARS",
          "name": "Vereniging van Eigenaars"
        },
        {
          "id": "UNKNOWN",
          "name": "Zakelijk, rechtsvorm niet bekend"
        }
      ],
      "validations": [],
      "rules": [ //this input will be rendered visible when partyType input equals ORGANIZATION.
        {
          "conditions": [ //multiple conditions can be specified and are interpreted as 'AND', aka all conditions must be true to trigger the action
            {
              "id": "partyType",
              "operator": "equals",
              "values": [
                "ORGANIZATION"
              ]
            }
          ],
          "actions": [ //multiple actions can be specified and will all be applied when the conditions are met
            {
              "action": "isVisible" //possible actions: isVisible, isDisabled
              "value": "true"
            }
          ]
        }
      ]
    },

  "accessPoint": {
    "name": "{{ean}}",
		"description": "{{accessPointType.name}} Access Point created by {{userId}} at {{now}}"
    "identification": {
      "externalId": "{{ean}}"
    },
    "type": "{{accessPointType.id}}",
		"relatedParties#partyList": [
			{
				"party": {
					"externalId": "{{cocNumber}}"
				},
				"sourceRole": "DEFAULT",
				"targetRole": "DEFAULT",
				"fromDate": "{{today}}"
			}
		]
  }

"batchRequest": { //this enables to iterate to create multiple entities
    "party#customers": [ //here you can use #inputlist to specify the input which contains the list.
      {
        "idGeneration": [
          "publicId"
        ],
        "type": "{{type.id}}",
        "roles": [
          "CUSTOMER"
        ],
        "name": "{{name}}"
      }
    ]
  }

{
  "inputDefinitions": [
    {
      "id": "customerName",
      "label": "Customer Name",
      "type": "string"
    },
    {
      "id": "customers",
      "label": "Customers",
      "type": "object",
			"asObject": false, // default if true -> the entity is returned instead of the id
      "inputDefinitions": [
        {
          "id": "type",
          "label": "Customer Type",
          "type": "enum",
          "options": [
            {
              "id": "PERSON",
              "name": "Person"
            },
            {
              "id": "ORGANIZATION",
              "name": "Organization"
            }
          ],
          "validations": [
            {
              "name": "required",
              "config": "true"
            }
          ]
        },
        {
          "id": "name",
          "label": "Name",
          "type": "string",
          "validations": [
            {
              "name": "required",
              "config": "true"
            }
          ]
        }
      ]
    }
  ],
  "batchRequest": {
    "party#customers": [
      {
        "idGeneration": [
          "publicId"
        ],
        "type": "{{type.id}}",
        "roles": [
          "CUSTOMER"
        ],
        "name": "{{name}}"
      }
    ]
  }
}

"shift": "{{unquote}}{{{shift}}}{{unquote}}", -> search and replace puts shift as object
"workers#workers": ["{{unquote}}{{{this}}}{{unquote}}"] -> search and replace puts array of workers objects

    "groups": [
      {
        "id": "edsnGeneral", -> groupId
        "label": "General", -> the label as how it is shown in the Front-End on the entity detail screen
        "order": 1, -> order in the structure
        "collapsed": false -> whether the group should be collapsed or not (either true or false)
      }
    ]

"createNewFields": false  -> whether new attributes can be added as extension on the entity

"fields": [
      {
        "key": "edsnProductType", -> the key of the attribute 
        "type": "Tenant Code",  -> defines the type of the attribute
        "codeType": "edsnProductType", -> codeType needs to be provided in case "type" is "Tenant Code"
				"defaultValue": "edsnProductType#ELK", -> only used in case a entity has timesliced details, when adding the initial timeslice, default values are applied. In case of an Tenant Code, the value need to include codeType#
        "list": false,
        "order": 1,
        "label": "Product", -> the label how the attribute is shown in the Front-End on the entity detail screen
        "groupId": "edsnGeneral", -> to which "group" this attribute is added
        "badge": "primary" -> which badge color is used, choices are primary, warning, danger, success. In case a entity has timesliced details, fields with a badge will be shown as columns
      }
]

Example Layout for stepper with four steps

"layout": {
    "variant": "stepper", //specifies the variant of the layout. Currently only stepper is implemented, can be extended in future to 'tabs', 'accordion', ...
    "orientation": "vertical", //specifies if the stepper is displayed vertically or horizontally
    "elements": [ //the elements array contains the steps
      {
        "id": "customerData", //id of the step
        "label": "Enter customer data", //label of the step
        "icon": "eva person-outline", //icon of the step
        "description": "Please provide the name of the customer", //description of the step (displayed above the form in the step)
        "fields": [ //list of fields which should be displayed in this step, this references id's of input definitions.
          "firstName",
          "lastName",
          "birthInformation"
        ]
      },
      {
        "id": "contactDetails",
        "label": "Enter contact details",
        "icon": "eva at-outline",
        "description": "Please provide the contact details for this customer",
        "fields": [
          "phoneNumber",
          "email",
          "communicationPreference"
        ]
      },
      {
        "id": "paymentInformation",
        "label": "Enter customer payment information",
        "icon": "eva credit-card-outline",
        "description": "Enter the payment information, this can also provided later",
        "fields": [
          "creditCardNumber",
          "creditCardValidUntil"
        ]
      },
      {
        "id": "customers",
        "label": "Add Related Customers",
        "icon": "eva credit-card-outline",
        "description": "Add here the related customers",
        "fields": [
          "relatedCustomers"
        ]
      }
    ]
  }

"{{someInputString}}"
"{{someInputEnum.id}}"
"{{someInputEnum.name}}"

"timeseries#someInputList": [ //the input list will be iterated and for each entry an array object is created
	{
		"identification": {
			"id": "{{id}}" //id input within the input list entry
		}
	}
]

"active": "{{#someInput}}true{{/someInput}}{{^someInput}}false{{/someInput}}"

"timeseries#someInputValue": [ //if someInputValue exists, then the timeseries array (with one element) is constructed
	{
		"identification": {
			"externalId": "BLA_BLA"
		},
		"name": "{{someOtherInput}}"
	}
],
"gateway#someInputValue": { //if someInputValue exists, then the gateway object is constructed
	"identification": {
		"externalId": "SOME_GATEWAY_EXT_ID"
	},
	...
}

"date": "{{#toLocalDateTenantZone}} {{myDateTimeInput}} {{/toLocalDateTenantZone}}",
"date": "{{#toLocalDateUtc}} {{myDateTimeInput}} {{/toLocalDateUtc}}",
"date": "{{#toLocalDate}} {{myDateTimeInput}} {{/toLocalDate}}"

"creationDateTime": "{{#toDateTimeUtc}} {{myDateInput}} {{/toDateTimeUtc}}",
"creationDateTime": "{{#toDateTimeTenantZone}} {{myDateInput}} {{/toDateTimeTenantZone}}",
"creationDateTime": "{{#toDateTime}} {{myDateInput}} {{/toDateTime}}"

"inputDefinitions": [
    {
      "id": "ean",
      "label": "EAN",
      "type": "string",
      "validations": [
        {
          "name": "required",  -> name of the validation //in this case whether the attribute is required to be filled in
          "config": "true"  -> configuration of the validation rule
        },
        {
          "name": "minlength", 
          "config": "18"
        },
        {
          "name": "maxlength",
          "config": "18"
        },
        {
          "name": "regex",
          "config": "^[0-9]{18}$"
        }
      ]
    }
	]