Parameter

Parameter object

Field	Type	Description
id	string	Platform generated ID. Example: "PRD-1234-1234-1234"
href	string	Resource reference. Example: "/v1/products/PRD-1234-1234-1234"
scope	string	Describes in which context parameter will be used. Example: "Agreement"
phase	string	Described in which process it will be used. Example: "Order"
type	string	Indicates which UI component will be used to capture information. Example: "Email"
options	One of: AddressOptions CheckboxOptions SingleLineTextOptions MultiLineTextOptions ChoiceOptions AddressOptions ContactOptions SubdomainOptions HeadingOptions DropDownOptions EmailOptions DataObjectOptions DateOptions	Are specific to a selected type and allow customization of UI component. Example: { "label": "Client address", "hintText": "please add your email", "placeholderText": "[e-mail]", "defaultValue": "none" }
constraints	ConstraintsObject	Used to specify characteristics of entire parameter, though it can have an impact of the validation of values too (i.e. turning on “Optional” will override any mandatory field within the UI components associated to the selected type.
group	ParameterGroup	Groups allow logical grouping of parameters, used by purchase wizard and represented as wizard step.
externalId	string	Used for programmatic processing, for example as a variable name within embedding templates or within 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" }
}