diff --git a/src/docs/version_002/resources/fields/formula_field/copy.md b/src/docs/version_002/resources/fields/formula_field/copy.md index 4f1a3c7..1526ec1 100644 --- a/src/docs/version_002/resources/fields/formula_field/copy.md +++ b/src/docs/version_002/resources/fields/formula_field/copy.md @@ -1 +1,25 @@ # Formula Field {% #formula-field %} + +Formula fields are a special type of field that can be used to calculate values based on other fields. These fields can have different output types and therefore have the following additional properties in addition to the standard [Field](#fields) properties. + +## Formula Field Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- outputType +- `string` +- Indicates the type of the output of the formula field. Possible values are: `Text`,`Numeric`, `DateAndTime`, or `ListValue`. + +--- + +- values +- `object[]` +- An array of [List Value](#list-value) objects that define the possible values of the formula field. This array will only be populated with values if the `outputType` is set to `ListValue`. + +{% /table %} diff --git a/src/docs/version_002/resources/fields/formula_field/example.md b/src/docs/version_002/resources/fields/formula_field/example.md index faec14c..57bc506 100644 --- a/src/docs/version_002/resources/fields/formula_field/example.md +++ b/src/docs/version_002/resources/fields/formula_field/example.md @@ -1 +1,34 @@ # The Formula Field Object + +{% code heading="FORMULA FIELD" defaultLanguage="json" %} + +```json +{ + "outputType": "ListValue", + "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": "Formula", + "status": "Enabled", + "isRequired": false, + "isUnique": false +} +``` + +{% /code %} diff --git a/src/docs/version_002/resources/fields/list_field/copy.md b/src/docs/version_002/resources/fields/list_field/copy.md index 8085e43..9f5ed4f 100644 --- a/src/docs/version_002/resources/fields/list_field/copy.md +++ b/src/docs/version_002/resources/fields/list_field/copy.md @@ -1 +1,31 @@ # List Field {% #list-field %} + +List fields are a special type of field that allow you to define a list of values that can be selected for the field. These fields have the following additional properties in addition to the standard [Field](#fields) properties. + +## List Field Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- multiplicity +- `string` +- Indicates whether the field is single or multi select. Possible values are: `MultiSelect` or `SingleSelect`. + +--- + +- listId +- `number` +- The id of the list that the list values are associated with. + +--- + +- values +- `object[]` +- An array of [List Value](#list-value) objects that define the possible values of the list field. + +- diff --git a/src/docs/version_002/resources/fields/list_field/example.md b/src/docs/version_002/resources/fields/list_field/example.md index 29d2a9f..6ed0f30 100644 --- a/src/docs/version_002/resources/fields/list_field/example.md +++ b/src/docs/version_002/resources/fields/list_field/example.md @@ -1 +1,35 @@ # The List Field Object + +{% code heading="LIST FIELD" defaultLanguage="json" %} + +```json +{ + "multiplicity": "MultiSelect", + "listId": 639, + "values": [ + { + "id": "71afe161-34f9-49d0-b45e-968b764c884c", + "name": "list_value_1", + "sortOrder": 1, + "numericValue": 1, + "color": "#008e8e" + }, + { + "id": "d40a74dd-abb5-4fbb-82c0-5766e871e2a4", + "name": "list_value_2", + "sortOrder": 2, + "numericValue": 2, + "color": "#a186be" + } + ], + "id": 4802, + "appId": 130, + "name": "multi_select_list_field", + "type": "List", + "status": "Enabled", + "isRequired": false, + "isUnique": false +} +``` + +{% /code %} diff --git a/src/docs/version_002/resources/fields/list_field/list_value/copy.md b/src/docs/version_002/resources/fields/list_field/list_value/copy.md index 9bbe70d..ba90d30 100644 --- a/src/docs/version_002/resources/fields/list_field/list_value/copy.md +++ b/src/docs/version_002/resources/fields/list_field/list_value/copy.md @@ -1 +1,43 @@ # List Value {% #list-value %} + +These are objects that represent the defined values of a [List Field](#list-field) or a [Formula Field](#formula-field) with a `ListValue` output type. + +## List Value Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- id +- `string` +- The unique id of the list value. + +--- + +- name +- `string` +- The name of the list value. + +--- + +- sortOrder +- `number` +- The sort order of the list value. + +--- + +- numericValue +- `number` +- The numeric value of the list value. + +--- + +- color +- `string` +- The color of the list value. + +{% /table %} diff --git a/src/docs/version_002/resources/fields/list_field/list_value/example.md b/src/docs/version_002/resources/fields/list_field/list_value/example.md index 3ff7cf8..65b2a04 100644 --- a/src/docs/version_002/resources/fields/list_field/list_value/example.md +++ b/src/docs/version_002/resources/fields/list_field/list_value/example.md @@ -1 +1,15 @@ # The List Value Object + +{% code heading="LIST VALUE" defaultLanguage="json" %} + +```json +{ + "id": "71afe161-34f9-49d0-b45e-968b764c884c", + "name": "list_value_1", + "sortOrder": 1, + "numericValue": 1, + "color": "#008e8e" +} +``` + +{% /code %} diff --git a/src/docs/version_002/resources/fields/reference_field/copy.md b/src/docs/version_002/resources/fields/reference_field/copy.md index 3722f85..6a751a6 100644 --- a/src/docs/version_002/resources/fields/reference_field/copy.md +++ b/src/docs/version_002/resources/fields/reference_field/copy.md @@ -1 +1,25 @@ # 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 identify the app or survey that the related content records are held in therefore they have the following additional properties in addition to the standard [Field](#fields) properties. + +## Reference Field Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- multiplicity +- `string` +- Indicates whether the field is single or multi select. Possible values are: `MultiSelect` or `SingleSelect`. + +--- + +- referenceAppId +- `number` +- The id of the app that the related content records are held in. + +{% /table %} diff --git a/src/docs/version_002/resources/fields/reference_field/example.md b/src/docs/version_002/resources/fields/reference_field/example.md index aefcdf7..bb718e0 100644 --- a/src/docs/version_002/resources/fields/reference_field/example.md +++ b/src/docs/version_002/resources/fields/reference_field/example.md @@ -1 +1,19 @@ # The Reference Field Object + +{% code heading="REFERENCE FIELD" defaultLanguage="json" %} + +```json +{ + "multiplicity": "MultiSelect", + "referencedAppId": 2, + "id": 4808, + "appId": 130, + "name": "multi_select_reference_field", + "type": "Reference", + "status": "Enabled", + "isRequired": false, + "isUnique": false +} +``` + +{% /code %}