Parameter Group

The Parameter Group object extends the base ParameterGroup object within the catalog.

This object contains the following attributes:

Field	Type	Description
id	string	Unique identifier of the parameterGroupDefinition. Example: PGD-1234-5678-9012
revision	unit, core	(Read-only) The revision number used for platform-level versioning. Example: 3
account	object, core	The account that owns the parameterGroupDefinition.
name	string, core	A descriptive name for the group. Example: Basic info
label	string, core	A translatable value for the step label shown on UI. Example: Business details
description	string, core	A description of the group. Example: Essential details of a business
parameters	object, core	Represents the orderedParameter object, which contains parameters included in the group. Example: [ { "id": "HPAD-233-33-xx3", "externalId": "HPAD-233-33-xx3", "group": { "id": "HPGR-7373-6782" }, "scope": "Form", "phase": "Request", "description": "The description", "context": "Case", "constraints": { "hidden": true, "readonly": true, "required": false }, "type": "SingleLineText", "options": { "name": "Favorite color", "placeholderText": "Ex: Green", "hintText": "Add here your favorite color. It can be any color.", }, "status": "active" ]
audit	object	(Read-only) Represents the audit object.

Ordered Parameter Group object

Represents a parameterGroup instance that has already been added to a form. Because the same parameterGroup can be reused across multiple forms in a different order, this entity is required. If the parameterGroup definition changes, the parameterGroup also changes to reflect those updates.

This object contains the following attributes:

Field	Type	Description
parameterGroup	object	A reference to the parameterGroup object. Example: { "id": "PGR-6790-8304-0001", "title": "Parameters", "label": "Create agreement", "description": "When creating a new agreement with SoftwareOne, you have the option to establish a new Microsoft account or connect it to an existing account you already hold with Microsoft.", }
form	object, core	Represents the form object. Example: { id: "FRM-123456" }
displayOrder	integer, core	The order of the parameterGroup within the form. Example: 100

Ordered Parameter object

Represents a parameter that has already been added to a group. Since the same parameter can be added to multiple groups in a different order, this entity is required. If the parameter definition changes, this grouped parameter also changes to reflect those updates.

Field	Type	Description
parameter	object	The parameterDefinition of this parameter. Example: { "id": "HPD-1234-1234", "name": "Company Name", "scope": "Form", "type": "TextField" ... }
parameterGroup	object	Represents the parameterGroup. Example: { "id": "PGR-6790-8304-0001", "title": "Parameters", "label": "Create agreement", "description": "When creating a new agreement with SoftwareOne, you can establish a new Microsoft account or connect an existing one.", }
displayOrder	integer, core	The order of the parameter within the group. Example: 100

Parameter Value object

The parameter object contains the value of the given parameter, along with additional information such as the value and validation error. This is a snapshot of the groupedParameter object.

Field	Type	Description
id	string, core	A unique identifier for the parameter value object. Example: PVH-1234-5678-9012
externalId	string	(Read-only) The ID of the parameter in the external system. Example: customer_address
revision	uint, core	(Read-only) Included to support new platform entity revisioning.
parameter	object, core	The parameterDefinition of this parameterValue. Example: { "id": "HPD-1234-1234" }
name	string, core	The name of the parameter.
value	string, core	(Optional) The parameter value.
displayValue	string	(Optional) The display value of the parameter.
displayOrder	integer, core	The order of the parameter within the group
scope	string, core	The scope of the parameter. Allowed values are form or case.
phase	string, core	The parameter phase. Allowed values:request or response.
constraints	object	Represents the constraints parameter, which stores a snapshot of the parameter's definition.
error	object	(Optional) Represents the error object. When specified represents a parameter validation error. Example: { "id": "E001234", "message": "Incorrect TAX number format" }
audit	object	(Read-only) Represents the audit object.