AddParameterToGroup Associates an existing parameter definition with the specified parameter group and assigns a display order. The parameter definition must already exist and will be added to the group's parameter collection. Returns the created ordered parameter definition with generated ID and audit information. Available for Operations accounts with helpdesk administration permissions.
The unique identifier of the parameter group
Ordered parameter definition within a parameter group
Defines the scope that determines where a parameter is applicable in the helpdesk system.
Defines the phase that determines when a parameter is used in the helpdesk workflow.
The description of the parameter
Customer contact email addressIndicates whether the parameter can accept multiple values
falseThe optional external identifier of the parameter for integration purposes
EXT-PARAM-123The display order of the parameter where a lower value indicates higher priority in the display sequence
1Defines who can see the parameter in the helpdesk system.
The type-specific options for the parameter which vary based on the parameter type
The number of cases using this parameter
The number of groups using this parameter
The number of forms using this parameter
Indicates whether the parameter definition has been marked as deleted.
The translatable label for the parameter group
Customer InformationThe optional description providing additional context for the parameter group
Basic customer details and contact informationDefines the scope that determines where a parameter is applicable in the helpdesk system.
Defines the phase that determines when a parameter is used in the helpdesk workflow.
The description of the parameter
Customer contact email addressIndicates whether the parameter can accept multiple values
falseThe optional external identifier of the parameter for integration purposes
EXT-PARAM-123The display order of the parameter where a lower value indicates higher priority in the display sequence
1Defines who can see the parameter in the helpdesk system.
The type-specific options for the parameter which vary based on the parameter type
The number of cases using this parameter
The number of groups using this parameter
The number of forms using this parameter
Indicates whether the parameter definition has been marked as deleted.
The optional external identifier associated with the parameter group
The number of parameter definitions in this group
The number of non-deleted forms this group is assigned to
Indicates whether the parameter group has been marked as deleted
falseCreated
Ordered parameter definition within a parameter group
Defines the scope that determines where a parameter is applicable in the helpdesk system.
Defines the phase that determines when a parameter is used in the helpdesk workflow.
The description of the parameter
Customer contact email addressIndicates whether the parameter can accept multiple values
falseThe optional external identifier of the parameter for integration purposes
EXT-PARAM-123The display order of the parameter where a lower value indicates higher priority in the display sequence
1Defines who can see the parameter in the helpdesk system.
The type-specific options for the parameter which vary based on the parameter type
The number of cases using this parameter
The number of groups using this parameter
The number of forms using this parameter
Indicates whether the parameter definition has been marked as deleted.
The translatable label for the parameter group
Customer InformationThe optional description providing additional context for the parameter group
Basic customer details and contact informationDefines the scope that determines where a parameter is applicable in the helpdesk system.
Defines the phase that determines when a parameter is used in the helpdesk workflow.
The description of the parameter
Customer contact email addressIndicates whether the parameter can accept multiple values
falseThe optional external identifier of the parameter for integration purposes
EXT-PARAM-123The display order of the parameter where a lower value indicates higher priority in the display sequence
1Defines who can see the parameter in the helpdesk system.
The type-specific options for the parameter which vary based on the parameter type
The number of cases using this parameter
The number of groups using this parameter
The number of forms using this parameter
Indicates whether the parameter definition has been marked as deleted.
The optional external identifier associated with the parameter group
The number of parameter definitions in this group
The number of non-deleted forms this group is assigned to
Indicates whether the parameter group has been marked as deleted
falseForbidden
Internal Server Error
No content
POST /public/v1/helpdesk/parameter-groups/{groupId}/parameters HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"id": "param-def-789",
"displayOrder": 2
}{
"id": "param-def-789",
"groupId": "group-456",
"displayOrder": 2,
"label": "Customer Email",
"type": "String",
"revision": 1,
"audit": {
"created": {
"at": "2024-02-02T10:00:00+00:00",
"by": "admin@example.com"
}
}
}