Step Data Fields
- Aaron Pettit (Unlicensed)
- Terra Yi (Unlicensed)
Owned by Aaron Pettit (Unlicensed)
The information in this document is currently in BETA and subject to change.
The Step Data Fields resource represents the data fields available on a step. Refer to the Action Create resource for usage.
Resource Properties
| Scope Parameter | stepdatafields |
|---|---|
| Location | /stepdatafields |
| Methods | GET |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Attributes
| Field | Description | Format | Required | Field Type | Restrictions | Notes |
|---|---|---|---|---|---|---|
| id | integer | default | ||||
| groupLabel | string | default | ||||
| fieldLabel | string | default | ||||
| fieldDescription | string | default | ||||
| defaultValue | string | default | ||||
| forceDefaultValue | boolean | default | ||||
| displayOrder | integer | default | ||||
| isRequired | boolean | default | ||||
| actionType | string | link | ||||
| step | string | link | ||||
| dataCollection | string | link | ||||
| dataField | string | link |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| stepdatafields.actionType | actiontypes | /actiontypes/{stepdatafields.actionType} |
| stepdatafields.step | steps | /steps/{stepdatafields.step} |
| stepdatafields.dataCollection | datacollections | /datacollections/{stepdatafields.dataCollection} |
| stepdatafields.dataField | datacollectionfields | /datacollectionfields/{stepdatafields.dataField} |