field
Represents a field in a schema.
XML
Attributes
| name |
type |
description |
| id |
string |
The field's id.
|
| isMultiValued |
boolean |
Indicates whether this field supports and expects multiple values or not. If true,
then this field accepts zero to many values. Otherwise, when false, this field can
only accept a single value (however, that value could be null).
Mandatory.
|
| displayAdvice |
displayAdvice |
A suggestion directed towards a client UI advising it about the most appropriate kind of UI
widget that could be used to render this field.
Optional.
|
Elements
| name (type) |
min/max
occurs |
description |
|
label (string)
|
0/1 |
A short, user-friendly name used for presenting this field to end-users.
Optional.
|
|
description (string)
|
0/1 |
The description of this field.
|
|
dataType (dataType)
|
0/1 |
The type of data supported and expected by this field.
Mandatory.
|
|
permissibleValues (permissibleValueList)
|
0/1 |
Defines the set of permissible values that can be assigned to this field. This property
should be assigned for fields that are presented with a list-based widget e.g. dropdown. This
field is used to obtain a list of entities for a field with an entity reference data type.
However, this can also be used to convert a non-entity, primitive field into a list e.g.
converting an integer field "CPU" into a choice between 2, 4, 8 or 16.
Optional (although entity reference fields without a permissible value list may be unusable).
|
|
state (state)
|
0/1 |
The ElementState of this field.
|
|
columns/column (field)
|
0/unbounded |
Future: Create a binding facet which auto-populates the values of the field based on a
separate selection in the form. E.g. selecting vApp Template X creates a separate value in
this field for each VM, collecting per-VM customization instructions like CPU, Memory, name
etc.
|
JSON
| property |
type |
description |
| id |
string |
The field's id.
|
| isMultiValued |
boolean |
Indicates whether this field supports and expects multiple values or not. If true,
then this field accepts zero to many values. Otherwise, when false, this field can
only accept a single value (however, that value could be null).
Mandatory.
|
| displayAdvice |
displayAdvice |
A suggestion directed towards a client UI advising it about the most appropriate kind of UI
widget that could be used to render this field.
Optional.
|
| label |
label (string)
|
A short, user-friendly name used for presenting this field to end-users.
Optional.
|
| description |
description (string)
|
The description of this field.
|
| dataType |
dataType (dataType)
|
The type of data supported and expected by this field.
Mandatory.
|
| permissibleValues |
permissibleValues (permissibleValueList)
|
Defines the set of permissible values that can be assigned to this field. This property
should be assigned for fields that are presented with a list-based widget e.g. dropdown. This
field is used to obtain a list of entities for a field with an entity reference data type.
However, this can also be used to convert a non-entity, primitive field into a list e.g.
converting an integer field "CPU" into a choice between 2, 4, 8 or 16.
Optional (although entity reference fields without a permissible value list may be unusable).
|
| state |
state (state)
|
The ElementState of this field.
|
| columns |
array of columns/column (field)
|
Future: Create a binding facet which auto-populates the values of the field based on a
separate selection in the form. E.g. selecting vApp Template X creates a separate value in
this field for each VM, collecting per-VM customization instructions like CPU, Memory, name
etc.
|