Parameter

The Parameter object contains the following properties:

Field	Type	Description
id	string	(Read-only) Platform-generated ID of the parameter.
scope	string	(Read-only) The context in which the parameter will be used.
phase	string	(Read-only) The process during which the parameter will be used.
context	string	(Read-only) Used only in the Order scope and during the Order phase. If the scope is not set to Order, the context value is assigned as None. Allowed values are: Change Configuration Purchase Termination None
type	string	(Read-only) Indicates the UI component that will be used to capture information.
options	object	Are specific to the selected field type and allow customization of the UI component. One of the following option‑object types: AddressOptions CheckboxOptions SingleLineTextOptions MultiLineTextOptions ChoiceOptions ContactOptions SubdomainOptions HeadingOptions DropDownOptions EmailOptions DataObjectOptions DateOptions
multiple	boolean	(Optional) Multiple values type.
constraints	object	(Optional) Represents the constraints object, which defines characteristics that apply to the entire parameter and may influence value validation. For example, enabling optional overrides any mandatory fields within the UI components associated with the selected type.
group	object	Represents the parameterGroup object that allows logical grouping of parameters. They are used by the purchase wizard and represented as a wizard step.
externalId	object	(Optional) Represents the externalIds object, which is used for programmatic processing, for example, as a variable name within embedding templates or a “connector” process.
status	string	Represents the current status of the parameter. Only active parameters are returned. Allowed values are: Draft Active Unpublished

Example

PARAMETER OBJECT

{
  "scope": "Order",
  "phase": "Order",
  "description": "Agreement identifier of the reseller",
  "externalId": "RES-233-33-xx3",
  "displayOrder": 100,
  "context": "Purchase",
  "multiple": true,
  "constraints": {
    "hidden": true,
    "readonly": true,
    "required": false,
    "capacity": {
      "min": 2,
      "max": 3
    }
  },
  "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"
}