Request Fields

1. Get Incident Custom Field Definitions

getIncidentCustomFieldDefinitions (String itemTypeId) (since 8.5)

Parameters

  • itemTypeId The itemTypeId of the Item Type associated with any given Incident

Description

Returns all Active custom fields applicable to an Incident associated with the specified Item Type (by Item Type Id). The returned object is a Map, containing a Map for each field definition, keyed on the schema ‘targetfield’ which can have values of custom[1-5] or typeCustom[1-5]. The keys on the child map represent all aspects of a custom field that could be required for rendering an alternative user interface. See ‘Custom Field Definition Map Structure’ below, for a description of the respective fields of each child Map.

2. Get Service Request Custom Field Definitions

getServiceRequestCustomFieldDefinitions (String itemTypeId) (since 8.5)

Parameters

  • itemTypeId The itemTypeId of the Item Type associated with any given Service Request

Description

Returns all Active custom fields applicable to a Service Request associated with the specified Item Type (by Item Type Id). The returned object is a Map, containing a Map for each field definition, keyed on the schema ‘targetfield’ which can have values of custom[1-5] or typeCustom[1-5]. The keys on the child map represent all aspects of a custom field that could be required for rendering an alternative user interface. See ‘Custom Field Definition Map Structure’ below, for a description of the respective fields of each child Map.

3. Get Problem Custom Field Definitions

getProblemCustomFieldDefinitions (String itemTypeId) (since 8.5)

Parameters

  • itemTypeId The itemTypeId of the Item Type associated with any given Problem

Description

Returns all Active custom fields applicable to a Problem associated with the specified Item Type (by Item Type Id). The returned object is a Map, containing a Map for each field definition, keyed on the schema ‘targetfield’ which can have values of custom[1-5] or typeCustom[1-5]. The keys on the child map represent all aspects of a custom field that could be required for rendering an alternative user interface. See ‘Custom Field Definition Map Structure’ below, for a description of the respective fields of each child Map.

4. Get Change Request Custom Field Definitions

getChangeRequestCustomFieldDefinitions (String itemTypeId) (since 8.5)

Parameters

  • itemTypeId The itemTypeId of the Item Type associated with any given Change Request

Description

Returns all Active custom fields applicable to a Change Request associated with the specified Item Type (by Item Type Id). The returned object is a Map, containing a Map for each field definition, keyed on the schema ‘targetfield’ which can have values of custom[1-5] or typeCustom[1-5]. The keys on the child map represent all aspects of a custom field that could be required for rendering an alternative user interface. See ‘Custom Field Definition Map Structure’ below, for a description of the respective fields of each child Map.

 

Custom Field Definition Map Structure

Each ‘Map’ result can contain the following keys. There is some variability depending on the field configuration…

Key Description
fieldname The display name of this field
datatype One of: [“String”, “Number”, “Boolean”, “Date”, “Currency”, “Hyperlink”]
format For Boolean datatypes, One of: [“True/False”, “Yes/No”]
For Date datatypes, One of [“Date”, “Date/Time”] followed by a single space character and a (Java) format string
options For Boolean datatypes, a Map, containing keys 0 & 1, and values of True and False, or Yes and No (respectively)
For String datatypes that have an option list, this contains the options with keys of the option id’s and values of the corresponding display strings
required Value of “true” or “false” signifying if completion of this field is mandatory for request updates to be processed
default If the field has a default value defined, it will be returned as a string against this key