Constraints Object

Represents the parameter constraints object.

Field
Type
Description

hidden

bool

This constraint is very powerful as it allows vendors to conditionally request information from the client. Since it is about “collecting” information it is obvious that the “hidden“ constraint is available only during the “order” phase.

Example: true

required

bool

All defined parameters are mandatory by default, so to make the parameter optional we have to turn on this constraint.

Example: false

readonly

bool

If the requirement is to prevent the Client from modifying a value of some parameter, then this constraint can be turned on which will disable the UI components effectively making them not editable. Example: true

capacity

Min and Max number of parameter values.

Example:

{
  min: 1,
  max: 2
}

Capacity Object

Field
Type
Description

min

number

Minimum specifies how many values the user must provide.

max

number

Maximum value shows how many values the user can provide.

Example

{
  "hidden": true,
  "readOnly": true,
  "required": false,
  "multiple": null
}

Last updated

Was this helpful?