Parameters

The Parameter object contains the following properties:

Field	Type	Description
id	string	The platform-generated ID of the parameter. Example: PRD-1234-1234-1234
href	string	Resource reference. Example: /v1/products/PRD-1234-1234-1234
scope	string	The context in which the parameter will be used. Example: Agreement
phase	string	The process during which the parameter will be used. Example: Order
type	string	Indicates the UI component that will be used to capture information. Example: Email
options	One of the following: AddressOptions CheckboxOptions SingleLineTextOptions MultiLineTextOptions ChoiceOptions AddressOptions ContactOptions SubdomainOptions HeadingOptions DropDownOptions EmailOptions DataObjectOptions DateOptions	The options are specific to a selected type and allow customization of the UI component. Example: { "label": "Client address", "hintText": "please add your email", "placeholderText": "[email protected]", "defaultValue": "none" }
constraints	constraints	Used to specify the characteristics of an entire parameter, which can also impact the validation of values. For instance, enabling Optional overrides any mandatory fields within the UI components associated with the selected type.
group	parameterGroup	Groups allow logical grouping of parameters. They are used by the purchase wizard and represented as a wizard step.
externalId	externalIds	Used for programmatic processing, for example, as a variable name within embedding templates or a “connector” process. Example: EXT-1234-1234

Example

PARAMETER OBJECT

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