Program Parameter

The Program Parameters object is a mechanism that enables vendors to specify additional information to be collected from and shared with a client, so that the client can get self-served within the SoftwareOne Marketplace.

This object contains the following attributes:

Field	Type	Description
id	string	(Read-only) The business identifier of the Parameter object.
href	string	(Read-only) A reference to the resource.
scope	string	(Read-only) The scope in which the parameter will be used. Allowed values: agreement, item, request, or subscription.
phase	string	(Read-only) The phase in which the process will be used. Allowed values: configuration, order, or fullfilment.
type	string	(Read-only) Indicates the UI component that will be used to capture information. Allowed values: SingleLineText MultiLineText Address Contact Checkbox Choice Subdomain Heading DropDown Email DataObject Date
options	object	These are specific to a selected type and allow customization of the UI component. Example: { "label": "Client address", "hintText": "enter your email", "placeholderText": "[e-mail]", "defaultValue": "none" }
constraints	object	Represents the constraints object, which specifies characteristics of the entire parameter, impacting value validation. For example, enabling 'Optional' overrides mandatory fields in UI components associated with the selected type.
group	object	(Optional) Represents the parameterGroup object, allowing logical grouping of parameters. It is used by the purchase wizard and represented as a step within the wizard.
externalId	string	(Optional) Used for programmatic processing, for example, as a variable name within templates or a connector process.
status	string	The status of the parameter. Only active parameters are returned.

Example

THE PROGRAM PARAMETERS OBJECT

{
  "scope": "Agreement",
  "phase": "Order",
  "description": "Agreement identifier of the reseller",
  "externalId": "RES-233-33-xx3",
  "displayOrder": 100,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": false
  },
  "type": "SingleLineText",
  "options": {
    "name": "Agreement Id",
    "placeholderText": "AGR-xxx-xxx-xxx",
    "hintText": "Add agreement id",
    "minChar": 15,
    "maxChar": 15,
    "defaultValue": null
  },
  "group": { 
    "id": "PGR-7373-6782" 
  },
  "status": "active"
}