Parameter Group

Parameter Group object

Field	Type	Description
id	string	Platform generated ID. Example: "PGR-6790-8304-0001"
href	string	Relative reference to object on API (always /products/{product-id}/parameter-groups/{id}). Example: "/products/PRD-6790-8304-0171/parameter-groups/PGR-6790-8304-0001"
name	string	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 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	The number of parameters in the group. Example: "5"
product	Product	Reference to Product object.

Example

PARAMETER GROUP OBJECT

{
    "id": "PGR-6790-8304-0001",
    "href": "/products/PRD-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,
    "product": {
        "id": "PRD-6790-8304-0171"
    }
}