URL: v3/render/form?category={ticket}&id={id}&mode=config
Method: GET
Description: It renders the form with config mode.
Request Payload:
| Parameter | Type | Optional/Required | Description |
| category | string | Required | Pass the category from the given lists(ticket, requester, organisation, problem, changes, releases, contract, asset, and license). |
| id | integer | Optional | If custom ticket form wants to render, then the custom ticket form id. |
Response Format: JSON
Response:-
{
"success": true,
"data": {
"id": 1,
"category": "ticket",
"icon_class": "fa-user-tie",
"name": "Default Ticket ",
"type": "helpdesk",
"is_public": 1,
"is_delete": 0,
"is_clone": 1,
"is_default": 1,
"is_active": 1,
"is_multiple": 1,
"is_user_form": 1,
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-26T08:43:31.000000Z",
"form_sections": [
{
"id": 1,
"category_id": 1,
"category_type": "App\\Form\\Models\\FormCategory",
"key": "ticket_properties",
"title": "Ticket Properties",
"sort_order": 0,
"data_type": "section",
"is_deletable": 0,
"label": "Ticket Properties",
"form_fields": {
"first": [
{
"id": 1,
"category_type": "App\\Form\\Models\\FormSection",
"category_id": 1,
"key": "requester",
"title": "Requester",
"data_type": "api",
"shortcode": null,
"pattern": null,
"validation_message": "",
"sort_order": 4,
"column": "first",
"is_active": 1,
"apply_form": 0,
"create_button": 0,
"is_edit_visible": 1,
"is_observable": 0,
"is_agent_config": 1,
"is_user_config": 1,
"required_for_agent": 1,
"required_for_user": 1,
"display_for_agent": 1,
"display_for_user": 1,
"default": 1,
"is_configurable": 0,
"is_deletable": 0,
"is_filterable": 1,
"show_description": 0,
"media_option": 0,
"request_time_information": 1,
"field_id": null,
"enable_extension": 0,
"concat_field_type": null,
"concat_field_id": null,
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-26T05:16:28.000000Z",
"display_on_edit": 0,
"required_on_edit": 0,
"required_for_closure": 0,
"label": "Requester",
"description": null,
"place_holder": null,
"union": [],
"form_identifier": "form_field_1",
"labels": [
{
"id": 2,
"labelable_type": "App\\Form\\Models\\FormField",
"labelable_id": 1,
"language": "en",
"label": "Requester",
"place_holder": null,
"description": "",
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-20T05:06:36.000000Z",
"form_identifier": "form_label_2"
}
],
"options": []
},
{
"id": 2,
"category_type": "App\\Form\\Models\\FormSection",
"category_id": 1,
"key": "cc",
"title": "CC",
"data_type": "multiselect",
"shortcode": null,
"pattern": null,
"validation_message": "",
"sort_order": 5,
"column": "first",
"is_active": 1,
"apply_form": 0,
"create_button": 0,
"is_edit_visible": 0,
"is_observable": 0,
"is_agent_config": 1,
"is_user_config": 0,
"required_for_agent": 0,
"required_for_user": 0,
"display_for_agent": 1,
"display_for_user": 0,
"default": 1,
"is_configurable": 1,
"is_deletable": 0,
"is_filterable": 1,
"show_description": 0,
"media_option": 0,
"request_time_information": 1,
"field_id": null,
"enable_extension": 0,
"concat_field_type": null,
"concat_field_id": null,
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-26T05:16:28.000000Z",
"display_on_edit": 0,
"required_on_edit": 0,
"required_for_closure": 0,
"label": "CC",
"description": null,
"place_holder": null,
"union": [],
"form_identifier": "form_field_2",
"labels": [
{
"id": 3,
"labelable_type": "App\\Form\\Models\\FormField",
"labelable_id": 2,
"language": "en",
"label": "CC",
"place_holder": null,
"description": "",
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-20T05:06:36.000000Z",
"form_identifier": "form_label_3"
}
],
"options": []
},
]
},
"form_identifier": "form_section_1",
"labels": [
{
"id": 1,
"labelable_type": "App\\Form\\Models\\FormSection",
"labelable_id": 1,
"language": "en",
"label": "Ticket Properties",
"place_holder": null,
"description": "",
"created_at": "2024-09-19T11:17:40.000000Z",
"updated_at": "2024-09-20T05:06:36.000000Z",
"form_identifier": "form_label_1"
}
]
}
],
"category_identifier": "ticket"
}
}