Program Parameters

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

The business identifier of the Parameter object.

Example: PAR-1234-1234-0001

href

string

A reference to the resource.

Example: /v1/program/PGR-1234-1234/PAR-1234-1234-0001

scope

string

The scope in which the parameter will be used.

Possible values: Agreement, Item, Request, or Subscription

phase

string

The phase in which the process will be used.

Possible values: Configuration, Order, or Fullfilment

type

string

Indicates the UI component that will be used to capture information. Possible values:

SingleLineText

MultiLineText

Address

Contact

Checkbox

Choice

Subdomain

Heading

DropDown

Email

DataObject

Date

options

These are specific to a selected type and allow customization of the UI component.

Example:

{
    "label": "Client address",
    "hintText": "enter your email",
    "placeholderText": "[email protected]",
    "defaultValue": "none"
}

constraints

constraintsObject

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

Allows logical grouping of parameters. Used by the purchase wizard and represented as a step within the wizard.

externalId

string

Used for programmatic processing, for example, as a variable name within templates or a connector process.

Example: EXT-1234-1234

status

string

Status of the parameter. Only active parameters are returned.

Example: Active

Example

{
  "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": "Aggreement Id",
    "placeholderText": "AGR-xxx-xxx-xxx",
    "hintText": "Add agreement id",
    "minChar": 15,
    "maxChar": 15,
    "defaultValue": null
  },
  "group": { "id": PGR-7373-6782" },
  "status": "active"
}

Last updated

Was this helpful?