Skip to main content

Handheld device (HHD) flow attributes. Defines a configurable RF/HHD workflow belonging to an HHD implementation. (Known internally as an RF flow.)

code
string
required

Unique code identifying the flow within its implementation. Immutable after creation.

Maximum string length: 50
flow_type
enum<string>
required

The kind of flow.

Available options:
standard,
task,
loading
implementation_id
integer
required

ID of the HHD implementation this flow belongs to.

name
string
required

Display name of the flow.

Maximum string length: 255
definition
object

JSON definition of the flow's steps and behaviour.

is_default
boolean | null

Whether this flow is the default for its implementation.