docs: add list values resource section

This commit is contained in:
Stevan Freeborn
2023-04-17 23:00:51 -05:00
parent dfac4e90ad
commit 07b7aff742
9 changed files with 85 additions and 11 deletions
@@ -20,6 +20,6 @@ Formula fields are a special type of field that can be used to calculate values
- 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`.
- An array of [List Value](#list-values) 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 %}
@@ -26,6 +26,6 @@ List fields are a special type of field that allow you to define a list of value
- values
- `object[]`
- An array of [List Value](#list-value) objects that define the possible values of the list field.
- An array of [List Value](#list-values) objects that define the possible values of the list field.
-
@@ -1,43 +0,0 @@
# 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 %}
@@ -1,15 +0,0 @@
# 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 %}