Program Parameter Groups

The Parameter Group Object represents a group of parameters. This object contains the following attributes:

Field
Type
Description

id

string

The platform generated ID.

Example: PGR-6790-8304-0001

href

string

Relative reference to the object in the API.

Example: /programs/PRG-6790-8304-0171/parameter-groups/PGR-6790-8304-0001

name

string

The name of the group.

Example: Parameters

label

string

Label displayed in the wizard steps selector. Example: Create agreement

description

string

Description of the group.

Example: 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

integer

Defines the display order.

Example: 100

default

boolean

Marks the default item group.

Example: true

parameterCount

integer

The number of parameters in the group.

Example: 5

program

A reference to the Program object.

Example

{
    "id": "PGR-6790-8304-0001",
    "href": "/program/PRG-6790-8304/parameter-groups/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,
    "program": {
        "id": "PRG-6790-8304-0171"
    }
}

Last updated

Was this helpful?