Get custom field

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/customFields/{classCode}/{customFieldId}

Sample URLs

https://{api-url}/api/v2/tenants/client_93/customFields/INCIDENT/UDF0000003790

https://{api-url}/api/v2/tenants/msp_9/customFields/INCIDENT/UDF0000001232

Use the supported entities along with their class code:

Custom fields are user defined fields to include additional information of the entity.

Status code

200 OK

Sample responses

An example of type DROPDOWN:

{
	"id": "UDF0000003790",
	"classCode": "INCIDENT",
	"displayLabel": "drop-down-api-lab",
	"name": "drop_down_api_lab_3790",
	"fieldType": "TYPE_DROPDOWN",
	"mandatory": false,
	"editable": true,
	"description": "Test case",
	"options": [{
			"label": "first",
			"value": "1"
		},
		{
			"label": "second",
			"value": "2"
		}
	]
}

An example of type TEXT:

{
	"id": "UDF0000003791",
	"classCode": "INCIDENT",
	"displayLabel": "text-api-lab",
	"name": "text_api_lab_3791",
	"fieldType": "TYPE_TEXT",
	"mandatory": false,
	"editable": true,
	"description": "test case for text field"
}

An example of type TEXTAREA:

{
	"id": "UDF0000003792",
	"classCode": "INCIDENT",
	"displayLabel": "multi line text-api-lab",
	"name": "multi_line_text_api_lab_3792",
	"fieldType": "TYPE_TEXTAREA",
	"mandatory": false,
	"editable": true,
	"description": "test case for multi line text"
}

An example of type NUMERIC:

{
	"id": "UDF0000003793",
	"classCode": "INCIDENT",
	"displayLabel": "Numeric-api-lab",
	"name": "numeric_api_lab_3793",
	"fieldType": "TYPE_NUMBER",
	"mandatory": false,
	"editable": true,
	"description": "numeric test case"
}

An example of type CHECKBOX:

{
	"id": "UDF0000003794",
	"classCode": "INCIDENT",
	"displayLabel": "checkbox-api-lab",
	"name": "checkbox_api_lab_3794",
	"fieldType": "TYPE_CHECKBOX",
	"mandatory": false,
	"editable": true,
	"description": "test case for check box",
	"options": [{
		"label": "yes",
		"value": "1"
	}]
}

An example of type DATE:

{
	"id": "UDF0000003795",
	"classCode": "INCIDENT",
	"displayLabel": "Date-ap-lab",
	"name": "date_ap_lab_3795",
	"fieldType": "TYPE_DATE",
	"mandatory": false,
	"editable": true,
	"description": "test case for date field"
}

An example of type DATETIME:

{
	"id": "UDF0000003796",
	"classCode": "INCIDENT",
	"displayLabel": "dateTime-api-lab",
	"name": "datetime_api_lab_3796",
	"fieldType": "TYPE_DATETIME",
	"mandatory": false,
	"editable": true,
	"description": "test case for Date and time"
}