OrderedParameterDefinition

Add parameter to a parameter group

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.

post/public/v1/helpdesk/parameter-groups/{groupId}/parameters

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/parameter-groups/{groupId}/parameters
  • Auth: none declared

Path parameters

groupIdstring required

The unique identifier of the parameter group

Request body

idstring
namestring
iconstring nullable
revisioninteger
scope'Case' | 'Form'

Defines the scope that determines where a parameter is applicable in the helpdesk system.

phase'Request' | 'Response'

Defines the phase that determines when a parameter is used in the helpdesk workflow.

descriptionstring

The description of the parameter

multipleboolean

Indicates whether the parameter can accept multiple values

externalIdstring nullable

The optional external identifier of the parameter for integration purposes

displayOrderinteger nullable

The display order of the parameter where a lower value indicates higher priority in the display sequence

optionsunknown
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'
isDeletedboolean

Indicates whether the parameter definition has been marked as deleted.

Example request

{
  "description": "Customer contact email address",
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1,
  "group": {
    "label": "Customer Information",
    "description": "Basic customer details and contact information"
  }
}

Response

Created

idstring
namestring
iconstring nullable
revisioninteger
scope'Case' | 'Form'

Defines the scope that determines where a parameter is applicable in the helpdesk system.

phase'Request' | 'Response'

Defines the phase that determines when a parameter is used in the helpdesk workflow.

descriptionstring

The description of the parameter

multipleboolean

Indicates whether the parameter can accept multiple values

externalIdstring nullable

The optional external identifier of the parameter for integration purposes

displayOrderinteger nullable

The display order of the parameter where a lower value indicates higher priority in the display sequence

optionsunknown
type'SingleLineText' | 'MultiLineText' | 'Address' | 'Contact' | 'Checkbox' | 'Choice' | 'Subdomain' | 'Heading' | 'DropDown' | 'Email' | 'DataObject' | 'Date' | 'DateAndTime' | 'Collection'
isDeletedboolean

Indicates whether the parameter definition has been marked as deleted.

Example response

{
  "description": "Customer contact email address",
  "externalId": "EXT-PARAM-123",
  "displayOrder": 1,
  "group": {
    "label": "Customer Information",
    "description": "Basic customer details and contact information"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.