Endpoint
/api/v2/tenants/{tenantId}/customFields/{classCode}/{customFieldId}
Path Parameters
tenantId
string

Describes the clientId of the tenant

classCode
string

Unique name of the custom form

customFieldId
string

Unique Id of the custom field in the custom form

Responses

OK

classCode
string

customField
boolean

defaultValue
string

description
string

displayLabel
string

editable
boolean

fieldType
string

id
string

mandatory
boolean

name
string

options
array

options.label
options.value
selectedOption
object

selectedOption.label
selectedOption.value
value
string

{
  "classCode": "INCIDENT",
  "description": "test case for check box",
  "displayLabel": "checkbox-api-lab",
  "editable": true,
  "fieldType": "TYPE_CHECKBOX",
  "id": "UDF0000003794",
  "mandatory": false,
  "name": "checkbox_api_lab_3794",
  "options": [
    {
      "label": "yes",
      "value": "1"
    }
  ]
}
{
  "classCode": "INCIDENT",
  "description": "test case for date field",
  "displayLabel": "Date-ap-lab",
  "editable": true,
  "fieldType": "TYPE_DATE",
  "id": "UDF0000003795",
  "mandatory": false,
  "name": "date_ap_lab_3795"
}
{
  "classCode": "INCIDENT",
  "description": "test case for Date and time",
  "displayLabel": "dateTime-api-lab",
  "editable": true,
  "fieldType": "TYPE_DATETIME",
  "id": "UDF0000003796",
  "mandatory": false,
  "name": "datetime_api_lab_3796"
}
{
  "classCode": "INCIDENT",
  "description": "Test case",
  "displayLabel": "drop-down-api-lab",
  "editable": true,
  "fieldType": "TYPE_DROPDOWN",
  "id": "UDF0000003790",
  "mandatory": false,
  "name": "drop_down_api_lab_3790",
  "options": [
    {
      "label": "first",
      "value": "1"
    },
    {
      "label": "second",
      "value": "2"
    }
  ]
}
{
  "classCode": "INCIDENT",
  "description": "numeric test case",
  "displayLabel": "Numeric-api-lab",
  "editable": true,
  "fieldType": "TYPE_NUMBER",
  "id": "UDF0000003793",
  "mandatory": false,
  "name": "numeric_api_lab_3793"
}
{
  "classCode": "INCIDENT",
  "description": "test case for text field",
  "displayLabel": "text-api-lab",
  "editable": true,
  "fieldType": "TYPE_TEXT",
  "id": "UDF0000003791",
  "mandatory": false,
  "name": "text_api_lab_3791"
}
{
  "classCode": "INCIDENT",
  "description": "test case for multi line text",
  "displayLabel": "multi line text-api-lab",
  "editable": true,
  "fieldType": "TYPE_TEXTAREA",
  "id": "UDF0000003792",
  "mandatory": false,
  "name": "multi_line_text_api_lab_3792"
}