Parameter Definition

Extends to base Parameter object introduced in the Catalog.

Field Name	Data Type	Description
id	string	A unique identifier for the parameter definition. Example: HPD-1234-5678-9012
externalId	string	Optional external id. Example: customer-address
revision	uint	Included to support new platform entity revisioning.
account	object	The account that owns the parameter definition.
name	string	A descriptive name for the parameter. Example: Customer address
type	string	The parameter data type. Allowed values are singleLineText, multiLineText, checkbox, choice, heading, dropDown, email, dataObject, or date. Note that the available parameter type might differ depending on the scope of the parameter (Form/Case).
scope	string	Parameter scope. Allowed values are form or case.
phase	string	Parameter phase. Allowed values are request or response.
constraints	object	Parameter constraints.
displayOrder	integer	Required for parameter of scope case. Example: 100
statistics	object (parameterStatistics)	Statistics about the parameter. Scope: Form { groupsCount: 10, formsCount: 5 } Scope: Case { casesCount: 5 }
audit	object	A reference to the audit object.

Parameter Statistics object

Field Name	Data Type	Description
groupsCount	integer	(readonly) The total count of parameter groups this parameter is linked to. Relevant for parameters of scope “form“ only. Won’t be returned for type “case”. Example: 29
casesCount	integer	(readonly) The total count of cases this parameter is linked to. Relevant for parameters of scope “case“ only. Won’t be returned for type “form”. Example: 29
formsCount	integer	(readonly) The total count of forms this parameter is indirectly linked to. Relevant for parameters of scope “form“ only. Won’t be returned for type “case”. Example: 29