Manage Custom Fields

Get and Update custom form field of a ticket Type

Notes

  • Custom fields are user defined fields to include additional information of the ticket Type.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • classCodestringrequired

    Unique name of the custom form

    Enum:
    SERVICEREQUESTACSTICKETTASKINCIDENTPROBLEMCHANGE
  • customFieldIdstringrequired

    Unique Id of the custom field in the custom form

Responses

  • 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...

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • classCodestringrequired

    Unique name of the custom form

    Enum:
    SERVICEREQUESTACSTICKETTASKINCIDENTPROBLEMCHANGE
  • customFieldIdstringrequired

    Unique Id of the custom field in the custom form

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

  • classCodestring

    Enum:
    SERVICEREQUESTACSTICKETCHANGETASKINCIDENTPROBLEM

    Default: INCIDENT

  • displayLabelstring

  • namestring

  • fieldTypestring

    Enum:
    TYPE_DROPDOWNTYPE_TEXTTYPE_TEXTAREATYPE_DATETIMETYPE_CHECKBOXTYPE_NUMBERTYPE_CUSTOM_FIELD

    Default: TYPE_TEXT

  • mandatoryboolean

  • editableboolean

  • defaultValuestring

  • descriptionstring

  • visibleToBusinessUsersboolean

  • intgEventNamestring

Loading Examples...