Parameter Group

The Parameter Group object contains the following properties:

Field
Type
Description

id

string

The identifier for the parameter group.

Example: PGR-6790-8304-0001

href

string

Relative reference to the object in the API.

Example: /products/PRD-6790-8304-0171/parameter-groups/PGR-6790-8304-0001

name

string

The name of the group.

Example: Parameters

label

string

The label displayed in the wizard steps selector.

Example: Create agreement

description

string

A description of the group.

Example: When creating a new agreement with SoftwareOne, you can establish a new Microsoft account or connect your existing account.

displayOrder

integer

Defines the display order.

Example: 100

default

boolean

Marks the default item group.

Example: true

parameterCount

integer

Number of parameters in the group.

Example: 5

product

Reference to the Product object.

Example

{
    "id": "PGR-6790-8304-0001",
    "title": "Parameters",
    "label": "Create agreement",
    "description": "When creating a new agreement with SoftwareOne, you have the option to establish a new Microsoft account or connect it to an existing account you already hold with Microsoft.",
    "displayOrder": 100,
    "default": true,
    "product": {
        "id": "PRD-6790-8304-0171"
    }
}

Last updated

Was this helpful?