URL
GET https://{api-url}/api/v2/tenants/{tenantId}/changeRequests/customForm
Sample URLs
https://{api-url}/api/v2/tenants/client_8/changeRequests/customForm
https://{api-url}/api/v2/tenants/msp_6/changeRequests/customForm
Learn how to create a custom form.
Status code
200 OK
Note
Identify if the field is either a custom default field: customField: false/true.
- customField: True indicates the field is a custom field
- customField: False indicates the field is a default field
Sample response
[{
"id": "21",
"classCode": "CHANGE",
"displayLabel": "Subject",
"name": "subject",
"fieldType": "TYPE_TEXT",
"mandatory": true,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "22",
"classCode": "CHANGE",
"displayLabel": "Description",
"name": "impact",
"fieldType": "TYPE_TEXTAREA",
"mandatory": true,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "24",
"classCode": "CHANGE",
"displayLabel": "Assignee Group",
"name": "assigneeGroup",
"fieldType": "TYPE_PICKLIST",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "25",
"classCode": "CHANGE",
"displayLabel": "Assign To",
"name": "assignedTo",
"fieldType": "TYPE_PICKLIST",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "31",
"classCode": "CHANGE",
"displayLabel": "Resources",
"name": "devices",
"fieldType": "TYPE_PICKLIST",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "23",
"classCode": "CHANGE",
"displayLabel": "Requested by",
"name": "requester",
"fieldType": "TYPE_PICKLIST",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "26",
"classCode": "CHANGE",
"displayLabel": "Category",
"name": "entityCategory",
"fieldType": "TYPE_DROPDOWN",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "27",
"classCode": "CHANGE",
"displayLabel": "Sub Category",
"name": "subCategory",
"fieldType": "TYPE_DROPDOWN",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "28",
"classCode": "CHANGE",
"displayLabel": "Priority",
"name": "priority",
"fieldType": "TYPE_DROPDOWN",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "136",
"classCode": "CHANGE",
"displayLabel": "Change Type",
"name": "changeType",
"fieldType": "TYPE_DROPDOWN",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "35",
"classCode": "CHANGE",
"displayLabel": "Schedule",
"name": "schedule",
"fieldType": "TYPE_DATES",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "32",
"classCode": "CHANGE",
"displayLabel": "Change Plan",
"name": "changePlan",
"fieldType": "TYPE_TEXTAREA",
"mandatory": true,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "33",
"classCode": "CHANGE",
"displayLabel": "Rollback Plan",
"name": "rollbackPlan",
"fieldType": "TYPE_TEXTAREA",
"mandatory": true,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "29",
"classCode": "CHANGE",
"displayLabel": "Test plan",
"name": "TestPlan",
"fieldType": "TYPE_TEXTAREA",
"mandatory": true,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "30",
"classCode": "CHANGE",
"displayLabel": "Cc",
"name": "cc",
"fieldType": "TYPE_TEXT",
"mandatory": false,
"editable": true,
"description": "",
"defaultValue": "",
"customField": false
},
{
"id": "UDF0000000019",
"classCode": "CHANGE",
"displayLabel": "Fix Version",
"name": "Change request fix version",
"fieldType": "TYPE_CHECKBOX",
"mandatory": false,
"editable": true,
"description": "",
"options": [{
"label": "Version 1",
"value": "1"
},
{
"label": "Version 2",
"value": "2"
}
],
"defaultValue": "0",
"customField": true
}
]