Get Ticket Custom Fields

Gets the list of custom fields attached to a ticket type.

Use the supported entities along with their class code:

Entity Class Code
Service request SERVICEREQUEST
Time-bound request ACSTICKET
Task TASK
Incident INCIDENT
Problem PROBLEM
Change request CHANGE
Scheduled tasks SCHEDULEDTASK
User USER
Knowledge base article KBARTICLE

Create custom fields for the entity and then use this endpoint to get the list of configured custom fields.

To create an ITSM entity, both Subject and Description are mandatory fields. Requested By, Assignee Group, and the other fields are optional. To include additional information, create custom fields for the respective entity from the following types of custom fields:

  • Drop-down
  • Text
  • Multi-line text
  • Numeric
  • Checkbox
  • Date
  • Date-time

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • classCodestringrequired

    Unique name of the custom form

    Enum:
    SERVICEREQUESTACSTICKETTASKINCIDENTPROBLEMCHANGE

Responses

  • classCodestring

    Ticket Ty

    Enum:
    SERVICEREQUESTACSTICKETCHANGETASKINCIDENTPROBLEM

    Default: INCIDENT

  • displayLabelstring

  • namestring

  • fieldTypestring

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