Parameter Group

Parameter Group

Extends the base ParameterGroup object within the catalog.

Field Name	Data Type	Description
id	string	A unique identifier of the ParameterGroupDefinition. Example: PGD-1234-5678-9012
revision	unit	Revision number (used for platform-level versioning). Example: 3
account	object	The account that owns the parameterGroupDefinition.
name	string	A descriptive name for the group. Example: Basic info
label	string	A translatable value for the step label shown on UI. Example: Business details
description	string	A description of the group. Example: Essential details of a business
parameters	object (orderedParameter)	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	The audit trail of the group. Allowed values: created, updated, or deleted.

Ordered Parameter Group object

This represents a parameterGroup already added to a Form. Since the same parameterGroup can be added to multiple forms in different order, this entity is needed. If the parameterGroup definition changes, this grouped parameterGroup also changes.

Field Name	Data Type	Description
parameterGroup	object	parameterGroup 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	form	Example: { id: "FRM-123456" }
displayOrder	integer	Order of the parameterGroup withing a form. Example: 100

Ordered Parameter object

This represents a parameter already added to a group. Since the same parameter can be added to multiple groups in different order, this entity is needed. If the parameter definition changes, this grouped parameter also changes.

Field Name	Data Type	Description
parameter	parameterDefinition	parameterDefinition of this parameter. Example: { "id": "HPD-1234-1234", "name": "Company Name", "scope": "Form", "type": "TextField" ... }
parameterGroup	parameterGroup	parameterGroup 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.", }
displayOrder	integer	Order of the parameter withing a group. Example: 100

Parameter Value object

Parameter object contains value of the given parameter along with additional information like value and validation error. This is an snapshot of the groupedParameter object

Similar to: Order Parameter Object

Field Name	Data Type	Description
id	string	A unique identifier for the parameter value object. Example: PVH-1234-5678-9012
externalId	string	The ID of the parameter in the external system. Example: customer_address
revision	uint	Included to support new platform entity revisioning.
parameter	object	The parameterDefinition of this parameterValue. Example: { "id": "HPD-1234-1234" }
name	string	The name of the parameter.
value	string	The parametervalue.
displayValue	string	The display value of the parameter.
displayOrder	integer	Order of the parameter within the group
scope	string	The scope of the parameter. Allowed values: form or case.
phase	string	The parameter phase. Allowed values: request or response.
constraints	constraints	A snapshot of the parameter definition constrains.
error	object	The standard error object. When specified represents parameter validation error. Example: { "id": "E001234", "message": "Incorrect TAX number format" }
audit	object	The audit trail of the parameter.