Custom Fields

Create custom form field for a ticket type. Creates a Custom Form Field.

Notes

Identify if the field is either a custom default field: customField: false/true.

  • customField: True indicates the field is a custom field
  • customField: False indicates the field is a default field

Add a custom field in the given default ticket type.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Request Body

application/json

  • classCodestringrequired

    Ticket Ty

    Enum:
    SERVICEREQUESTACSTICKETCHANGETASKINCIDENTPROBLEM

    Default: INCIDENT

  • displayLabelstringrequired

  • namestring

  • fieldTypestringrequired

    Type of Custom Fields Area

    Enum:
    TYPE_CUSTOM_FIELDTYPE_DROPDOWNTYPE_TEXTTYPE_TEXTAREATYPE_NUMBERTYPE_DATETYPE_DATETIMETYPE_CHECKBOX
  • mandatoryboolean

  • editableboolean

  • descriptionstring

  • valuestring

  • defaultValuestring

  • optionsarray

  • selectedOptionobject

  • customFieldboolean

  • removeOptionsarray

    This is only used during updating a custom field.

  • visibleToBusinessUsersboolean

    Enable visibility to bussiness users

  • activeboolean

    Enable field visibility

  • intgEventUUIdstring

    Integration Outbound Search Event UUID (If field type is TYPE_CUSTOM_FIELD then intgEventUUId is mandatory)

Loading Examples...

Responses

Loading Examples...