Defining JSON Fields
The following properties are applicable to a JSON field.
|
Tab |
Property |
Description |
Additional Information |
|---|---|---|---|
| General | Domain Parent | Specifies the domain parent of the selected field | |
| Enum List | Specifies the elements in the enum array | ||
| Name | Specifies the name of the field |
|
|
| Physical Name | Specifies the physical name of the field | ||
| Harden Strategy | Specifies how physical data types are applied and managed within the JSON Field Editor |
Inherit: Specifies that the field inherits its data type from its domain or parent. Override: Specifies that a new data type can be manually set, overriding the inherited one. Harden: Specifies that the data type is locked, preventing further changes and ensuring consistency across the schema |
|
| Physical Data Type | Specifies the physical data type of the field | ||
|
SDI |
Specifies that the selected field is Sensitive Data Indicator |
|
|
| Title |
Specifies the title of the field |
Updating the field title also updates the logical name of the field. This will not change the physical name of the field. |
|
|
Definition Type |
Specifies the definition of the field |
Available only for the $Defs field when the Physical Data Type is set to Object and includes the following types:
|
|
| Min Length | Specifies the minimum length of a string | ||
| Max Length | Specifies the maximum length of a string | ||
| Pattern | Specifies the regular expression used to validate the string | ||
| Content Encoding | Specifies the encoding used to store the contents | ||
| Content Media Type | Specifies the MIME type of the contents of the string | ||
| Format | Specifies the format for basic semantic commonly used basic semantic validation on strings | ||
| Const | Specifies a value that restricts the acceptable value to this value | ||
| Ref | Specifies the definition of the field | ||
| Default Value | Specifies the default value for the field | ||
| Description | Specifies the purpose of the data in the schema in detail | ||
| Is Required | Specifies whether the field is mandatory | ||
| Dependencies | Specifies the fields whose presence allows the schema of the object to change | ||
| Combining Schema Option |
Specifies the keyword for combining schemas together |
allOf: Indicates that the given value must be valid against all of the subschemas anyOf: Indicates that the given value must be valid against any of the subschemas oneOf: Indicates that the given value must be valid against exactly one of the subschemas not: Indicates that the given value must not be valid against the given schema |
|
| Value | Specifies the value for the field |
|
|
| Union Data Type | Specifies one or more primitive data types that apply to the field | ||
| Is Pattern Properties | Specifies whether the field is the regular expression and schema that validates an additional property |
|
|
| Title | Specifies the purpose of data in the schema in short | Available when the Domain Parent is set to Number | |
| Minimum | Specifies the minimum value of a number field | Available when the Domain Parent is set to Number | |
| Maximum | Specifies the maximum value of a number field | Available when the Domain Parent is set to Number | |
| Exclusive Maximum | Specifies whether the value set in Maximum is excluded | Available when the Domain Parent is set to Number | |
| Exclusive Minimum | Specifies whether the value set in Minimum is excluded | Available when the Domain Parent is set to Number | |
| Multiple of | Specifies a number such that only its multiples are permissible in the field | Available when the Domain Parent is set to Number | |
|
UDP |
Property | Specifies the user-defined properties added using the User Defined Properties editor | Selecting the Is Database Property checkbox in the User Defined Properties editor enables the user-defined properties to be included in forward engineering. Additionally, you must also select the UPD checkbox in the Option Selection section of the Forward Engineer Schema Generation Wizard. |
|
Copyright © 2025 Quest Software, Inc. |