Parameter
The Parameter object contains the following properties:
id
string
Platform-generated ID of the parameter.
Example: PRD-1234-1234-1234
href
string
Resource reference.
Example: /v1/products/PRD-1234-1234-1234
scope
string
Context in which the parameter will be used.
Example: Agreement
phase
string
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:
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:
constraints
ConstraintsObject
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
Groups allow logical grouping of parameters. They are used by the purchase wizard and represented as a wizard step.
externalId
string
Used for programmatic processing, for example, as a variable name within embedding templates or a “connector” process.
Example: EXT-1234-1234
Example
Last updated
Was this helpful?