Add parameter to group

Add parameter to a parameter group

post

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.

Path parameters

groupIdstringRequired

The unique identifier of the parameter group

Body

Ordered parameter definition within a parameter group

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

scopestring · enumOptional

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

Possible values:

phasestring · enumOptional

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

Possible values:

descriptionstringOptional

The description of the parameter

Example: Customer contact email address

multiplebooleanOptional

Indicates whether the parameter can accept multiple values

Example: false

externalIdstring · nullableOptional

The optional external identifier of the parameter for integration purposes

Example: EXT-PARAM-123

displayOrderinteger · int32 · nullableOptional

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

Example: 1

optionsany · nullableOptional

The type-specific options for the parameter which vary based on the parameter type

typestring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the parameter definition has been marked as deleted.

Responses

201

Created

application/json

Ordered parameter definition within a parameter group

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

scopestring · enumOptional

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

Possible values:

phasestring · enumOptional

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

Possible values:

descriptionstringOptional

The description of the parameter

Example: Customer contact email address

multiplebooleanOptional

Indicates whether the parameter can accept multiple values

Example: false

externalIdstring · nullableOptional

The optional external identifier of the parameter for integration purposes

Example: EXT-PARAM-123

displayOrderinteger · int32 · nullableOptional

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

Example: 1

optionsany · nullableOptional

The type-specific options for the parameter which vary based on the parameter type

typestring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the parameter definition has been marked as deleted.

403

Forbidden

application/json

500

Internal Server Error

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

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": "[e-mail]"
    }
  }
}