Documentation is now available for the Fall 2020 Update release!

Get incident custom form

This endpoint is used to retrieve the custom form for an incident.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/incidents/customForm

Sample URLs

https://{api-url}/api/v2/tenants/client_8/incidents/customForm
https://{api-url}/api/v2/tenants/msp_6/incidents/customForm

Learn how to create a custom form.

Status code

200 OK

Sample response

[{
		"id": "36",
		"classCode": "INCIDENT",
		"displayLabel": "Subject",
		"name": "subject",
		"fieldType": "TYPE_TEXT",
		"mandatory": true,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "37",
		"classCode": "INCIDENT",
		"displayLabel": "Description",
		"name": "impact",
		"fieldType": "TYPE_TEXTAREA",
		"mandatory": true,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "38",
		"classCode": "INCIDENT",
		"displayLabel": "Requested by",
		"name": "requester",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "39",
		"classCode": "INCIDENT",
		"displayLabel": "Assignee Group",
		"name": "assigneeGroup",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": true,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "40",
		"classCode": "INCIDENT",
		"displayLabel": "Assign To",
		"name": "assignedTo",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "41",
		"classCode": "INCIDENT",
		"displayLabel": "Resources",
		"name": "devices",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "42",
		"classCode": "INCIDENT",
		"displayLabel": "Category",
		"name": "entityCategory",
		"fieldType": "TYPE_DROPDOWN",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "43",
		"classCode": "INCIDENT",
		"displayLabel": "SubCategory",
		"name": "subCategory",
		"fieldType": "TYPE_DROPDOWN",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "46",
		"classCode": "INCIDENT",
		"displayLabel": "Priority",
		"name": "priority",
		"fieldType": "TYPE_DROPDOWN",
		"mandatory": true,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "48",
		"classCode": "INCIDENT",
		"displayLabel": "Due Date",
		"name": "dueDate",
		"fieldType": "TYPE_DATETIME",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "49",
		"classCode": "INCIDENT",
		"displayLabel": "Attach Problem/Change Request",
		"name": "attachTicket",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "50",
		"classCode": "INCIDENT",
		"displayLabel": "Attach Incident",
		"name": "parentTicket",
		"fieldType": "TYPE_PICKLIST",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "51",
		"classCode": "INCIDENT",
		"displayLabel": "To",
		"name": "toEmail",
		"fieldType": "TYPE_TEXT",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "52",
		"classCode": "INCIDENT",
		"displayLabel": "Cc",
		"name": "cc",
		"fieldType": "TYPE_TEXT",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "",
		"customField": false
	},
	{
		"id": "UDF0000000006",
		"classCode": "INCIDENT",
		"displayLabel": "Issue Type",
		"name": "spleveldropbox_6",
		"fieldType": "TYPE_DROPDOWN",
		"mandatory": false,
		"editable": true,
		"description": "Issue Type ",
		"options": [{
				"label": "Bug",
				"value": "Bug"
			},
			{
				"label": "Task",
				"value": "Task"
			},
			{
				"label": "New Feature",
				"value": "New Feature"
			},
			{
				"label": "Improvement",
				"value": "Improvement"
			},
			{
				"label": "Production Issue",
				"value": "Production Issue"
			}
		],
		"defaultValue": "",
		"customField": true
	},
	{
		"id": "UDF0000000004",
		"classCode": "INCIDENT",
		"displayLabel": "NE_Department",
		"name": "ne_department_4",
		"fieldType": "TYPE_DROPDOWN",
		"mandatory": false,
		"editable": true,
		"description": "NE_Department",
		"options": [{
				"label": "General",
				"value": "2"
			},
			{
				"label": "CBU-Windows",
				"value": "3"
			},
			{
				"label": "CBU-RSA Projects",
				"value": "6"
			},
			{
				"label": "Smart Escalate",
				"value": "7"
			},
			{
				"label": "MSP Tools",
				"value": "8"
			}
		],
		"defaultValue": "",
		"customField": true
	},
	{
		"id": "UDF0000000016",
		"classCode": "INCIDENT",
		"displayLabel": "Information",
		"name": "Previous incident info",
		"fieldType": "TYPE_TEXT",
		"mandatory": false,
		"editable": true,
		"description": "",
		"defaultValue": "Info",
		"customField": true
	}
]