diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index a562965..547b99d 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -83,6 +83,12 @@ export const versionOne: DocsStructure = { copy: 'copy.md', example: 'example.md', }, + { + title: 'Reference Field', + folder: 'reference_field', + copy: 'copy.md', + example: 'example.md', + }, ], }, ], diff --git a/src/docs/version_001/resources/fields/formula_field/example.md b/src/docs/version_001/resources/fields/formula_field/example.md index e69de29..a54aea7 100644 --- a/src/docs/version_001/resources/fields/formula_field/example.md +++ b/src/docs/version_001/resources/fields/formula_field/example.md @@ -0,0 +1,34 @@ +# The Formula Field Object + +{% code heading="FORMULA FIELD" defaultLanguage="json" %} + +```json +{ + "OutputType": 3, + "Values": [ + { + "Id": "b235afb2-b786-4c87-bce9-fbd700e246c1", + "Name": "list_value_1", + "SortOrder": 1, + "NumericValue": 1, + "Color": "#6dcff6" + }, + { + "Id": "5cd7cd55-d6a6-40e0-a560-8aa407c13210", + "Name": "list_value_2", + "SortOrder": 2, + "NumericValue": 2, + "Color": "#8e468e" + } + ], + "Id": 4815, + "AppId": 130, + "Name": "list_formula_field", + "Type": 900, + "Status": 0, + "IsRequired": false, + "IsUnique": false +} +``` + +{% /code %} diff --git a/src/docs/version_001/resources/fields/reference_field/copy.md b/src/docs/version_001/resources/fields/reference_field/copy.md index e69de29..2dd0779 100644 --- a/src/docs/version_001/resources/fields/reference_field/copy.md +++ b/src/docs/version_001/resources/fields/reference_field/copy.md @@ -0,0 +1,38 @@ +# Reference Field {% #reference-field %} + +Reference fields are a special type of field that allow you to create relationships between one or more content records. These fields have the following additional properties in addition to the standard [Field](#fields) properties. + +## Reference Field Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- multiplicity +- `number` +- Indicates whether the field is single or multi select. Possible values are: `0` or `1`. + +{% /table %} + +### Multiplicity Types + +{% table %} + +- Multiplicity Type Value +- Multiplicity Type Description + +--- + +- 0 +- Indicates the reference field is single select and will only ever hold one value. + +--- + +- 1 +- Indicates the reference field is multi select and can contain more than one value. + +{% /table %} diff --git a/src/docs/version_001/resources/fields/reference_field/example.md b/src/docs/version_001/resources/fields/reference_field/example.md index e69de29..9450f72 100644 --- a/src/docs/version_001/resources/fields/reference_field/example.md +++ b/src/docs/version_001/resources/fields/reference_field/example.md @@ -0,0 +1,18 @@ +# The Reference Field Object + +{% code heading="REFERENCE FIELD" defaultLanguage="json" %} + +```json +{ + "Multiplicity": 1, + "Id": 4808, + "AppId": 130, + "Name": "multi_select_reference_field", + "Type": 500, + "Status": 0, + "IsRequired": false, + "IsUnique": false +} +``` + +{% /code %}