docs: added info for sub field types
This commit is contained in:
@@ -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 %}
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
Reference in New Issue
Block a user