Step Data Fields

Owned by Aaron Pettit (Unlicensed)
Last updated: May 30, 2019 by Terra Yi (Unlicensed)
1 min read
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 Parameterstepdatafields
Location/stepdatafields
MethodsGET
Default Page Size50
Max Page Size200
Default IncludesNone


Resource Attributes
FieldDescriptionFormatRequiredField TypeRestrictionsNotes
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
IdentifierResourceLocation Template
stepdatafields.actionTypeactiontypes/actiontypes/{stepdatafields.actionType}
stepdatafields.stepsteps/steps/{stepdatafields.step}
stepdatafields.dataCollectiondatacollections/datacollections/{stepdatafields.dataCollection}
stepdatafields.dataFielddatacollectionfields/datacollectionfields/{stepdatafields.dataField}