OrderedParameterDefinition

Retrieve a parameter within parameter group by ID

GetGroupParameter Retrieves a specific parameter definition that belongs to the specified parameter group. Supports RQL select parameter for field filtering to optimize response payload. Returns 404 if the parameter does not exist, does not belong to the group, or the user lacks access. Available for Operations accounts with helpdesk administration permissions.

get/public/v1/helpdesk/parameter-groups/{groupId}/parameters/{id}

Request

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

Path parameters

groupIdstring required

The unique identifier of the parameter group

idstring required

The unique identifier of the parameter

Query parameters

selectstring

Optional RQL select statement to filter fields

Response

OK

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.