Parameter Definition

This object extends the base Parameter definition, inheriting its core fields and behaviors.

Field	Data	Description
id	string	A unique identifier for the parameter definition. Example: HPD-1234-5678-9012
externalId	string, core	The optional external ID. Example: customer-address
revision	uint, core	Included to support new platform entity revisioning.
account	object, core	The account that owns the parameter definition.
name	string, core	A descriptive name for the parameter.
type	string, core	The parameter's data type. Allowed values are: singleLineText multiLineText checkbox choice heading dropDown email dataObject date The available parameter types may vary depending on the parameter’s scope (Form or Case).
scope	string, core	Indicates the scope of the parameter. Allowed values are form or case.
phase	string, core	Indicates the phase of the parameter. Allowed values are request or response.
constraints	object, core	Represents the constraints object.
displayOrder	integer	Required for parameters with a scope of case.
statistics	object	Represents the parameterStatistics object, which contains statistics about the parameter. Scope: Form { groupsCount: 10, formsCount: 5 } Scope: Case { casesCount: 5 }
audit	object	Represents the audit object.

Parameter Statistics object

Field	Type	Description
groupsCount	integer	(Read‑only) The total number of parameter groups this parameter is linked to. Relevant only for parameters with scope form. Not returned for parameters of type case.
casesCount	integer	(Read‑only) The total number of cases this parameter is linked to. Relevant only for parameters with scope case. Not returned for parameters of type form.
formsCount	integer	(Read‑only) The total number of forms this parameter is indirectly linked to. Relevant only for parameters with scope form. Not returned for parameters of type case.