Interface APIs are used to trigger user interface events in the page. For example, you can include openNote API to automatically open a note with a default text whenever the user changes the status of a ticket.
Global Interface APIs
The following APIs are available to all apps that are located in the ticket and change details page:Show Modal - This API is used to open a Modal dialog box in an iframe to display HTML content to the user.
Note:
Events API and Interface API are not allowed within the Modal iframe.
template.html
Copied Copy1 | client.interface.trigger("showModal", {title: "Sample Modal", template: "modal.html"}) |
If your app includes services such as Data API, Request API, you will need to include the following Freshclient link within the Modal iframe as shown below:
modal.html
Copied Copy1 | <script src="http://static.freshdev.io/fdk/2.0/assets/fresh_client.js"></script> |
Show Confirm - This API is used to display a confirmation dialog to the user with the title, message. By default, the dialog shows OK and Cancel buttons.
Note:
1. Timeout for confirmation dialog is 10 seconds.
2. Maximum character length for save and cancel label is 20.
Sample confirmation dialog with default buttons
Copied Copy1 2 | client.interface.trigger("showConfirm", {title: "Sample Confirm", message: "Are you sure you want to close this ticket?"}) /*"title" and "message" should be plain text.*/ |
Sample confirmation dialog with saveLabel and cancelLabel
Copied Copy1 2 | client.interface.trigger("showConfirm", {title: "Sample Confirm", message: "Do you want to save the changes?", saveLabel: "save", cancelLabel: "ignore"}) /*"title" and "message" should be plain text.*/ |
Show Notifications - This API is used to display notifications with the type and message. Following are the different types of notifications that you can use:
Sample notification with message
Copied Copy1 2 | client.interface.trigger("showNotify", {type: "success", message: "sample notification"}) /*"title" and "message" should be plain text.*/ |
Ticket Details Page Interface
Ticket Page Interface Actions
The following APIs are available to all apps that are located in the ticket details page:- Expand Conversations
- Hide Attachments
- Show Attachments
- Hide Ticket Delete
- Show Ticket Delete
- Open Reply
- Open Note
- Add Task
- Hide Due Date Edit
- Show Due Date Edit
- Hide Note
- Show Note
- Hide Ticket Property Fields
- Show Ticket Property Fields
- Set Value for Ticket Property Fields
- Disable Ticket Property Fields
- Enable Ticket Property Fields
- Set Note Type
- Start Timer
- Toggle Timer
- Update Ticket Properties
Expand Conversations - If there are more than three conversations, they are collapsed in the ticket details page. This API can be used to expand them and display all the conversations.
Copied Copy1 | client.interface.trigger("click", {id: "expandConversations"}) |
Hide Attachments - This API hides the attachments in the conversations in the ticket details page.
Copied Copy1 | client.interface.trigger("hideElement", {id: "attachments"}) |
Show Attachments - This API is used to display the attachments in the conversations, if hidden.
Copied Copy1 | client.interface.trigger("showElement", {id: "attachments"}) |
Hide Ticket Delete - This API hides the ticket delete option in the ticket details page.
Copied Copy1 | client.interface.trigger("hideElement", {id: "ticketDelete"}) |
Show Ticket Delete - This API is used to display the ticket delete icon in the ticket details page if hidden.
Copied Copy1 | client.interface.trigger("showElement", {id: "ticketDelete"}) |
Open Reply - This API is used to open the Reply box and add the text in the textbox. Using this API will also invoke any callback function if specified using ticket.replyClick API.
Copied Copy1 | client.interface.trigger("click", {id: "openReply", text: "Text to be inserted"}) |
Open Note - This API is used to open the Note box and add the text in the textbox. Using this API will also invoke any callback function if specified using the ticket.notesClick API.
Copied Copy1 | client.interface.trigger("click", {id: "openNote", text: "Text to be inserted"}) |
Add Task - This API is used to open the Add Task form and add the text in the description.
Copied Copy1 | client.interface.trigger("click", { id: "addTask", text: "text to be inserted" }); |
Hide Due Date Edit - This API is used to hide the due date edit button
Copied Copy1 | client.interface.trigger("hideElement", { id: "dueDateEdit" }); |
Show Due Date Edit - This API is used to display the due date edit button, if hidden.
Copied Copy1 | client.interface.trigger("showElement", { id: "dueDateEdit" }); |
Hide Note - his API hides the note option from all the locations such as ticket top navigation and bottom coversation bar.
Copied Copy1 | client.interface.trigger("hideElement", { id: "note" }); |
Show Note -This API displays the note option from all the locations such as top navigation and bottom conversation bar
Copied Copy1 | client.interface.trigger("showElement", { id: "note" }); |
Hide Ticket Property Fields - This API hides the selected ticket properties field in the ticket details page.
Copied Copy1 | client.interface.trigger ("hideElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("hideElement", {id: "status"}) |
| Priority |
client.interface.trigger ("hideElement", {id: "priority"}) |
| Source |
client.interface.trigger ("hideElement", {id: "source"}) |
| Impact |
client.interface.trigger ("hideElement", {id: "impact"}) |
| Urgency |
client.interface.trigger ("hideElement", {id: "urgency"}) |
| Type |
client.interface.trigger ("hideElement", {id: "type"}) |
| Agent |
client.interface.trigger ("hideElement", {id: "agent"}) |
| Department |
client.interface.trigger ("hideElement", {id: "department"}) |
| Category |
client.interface.trigger ("hideElement", {id: "category"}) |
| Group |
client.interface.trigger ("hideElement", {id: "group"}) |
| custom field |
client.interface.trigger ("hideElement", {id: "customfield name"}) |
Show Ticket Property Fields - This API displays the selected ticket property field if hidden.
Copied Copy1 | client.interface.trigger ("showElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("showElement", {id: "status"}) |
| Priority |
client.interface.trigger ("showElement", {id: "priority"}) |
| Source |
client.interface.trigger ("showElement", {id: "source"}) |
| Type |
client.interface.trigger ("showElement", {id: "type"}) |
| Impact |
client.interface.trigger ("showElement", {id: "impact"}) |
| Urgency |
client.interface.trigger ("showElement", {id: "urgency"}) |
| Agent |
client.interface.trigger ("showElement", {id: "agent"}) |
| Department |
client.interface.trigger ("showElement", {id: "department"}) |
| Category |
client.interface.trigger ("showElement", {id: "category"}) |
| Group |
client.interface.trigger ("showElement", {id: "group"}) |
| custom field |
client.interface.trigger ("showElement", {id: "customfield name"}) |
Set Value for Ticket Property Fields - This API displays the selected ticket property field with a preset value.
Copied Copy1 | client.interface.trigger("setValue", {id: "property", value: "value"}); |
The following table lists all the property fields for which default values can be set:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger("setValue", {id: "status", value: 3}) |
| Priority |
client.interface.trigger("setValue", {id: "priority", value: 3}) |
| Source |
client.interface.trigger("setValue", {id: "source", value: 2}) |
| Ticket |
client.interface.trigger("setValue", {id: "type", value: "Incident"}) |
| Group |
client.interface.trigger("setValue", {id: "group", value: 10}) |
| Agent |
client.interface.trigger("setValue", {id: "agent", value: 30}) |
| Department |
client.interface.trigger("setValue", {id: "department", value: 1}) |
| custom field |
client.interface.trigger("setValue", {id: "customfield name", value: 3}) |
Disable Ticket Property Fields - This API displays the selected ticket property field with a preset value and this value will be disabled for editing.
Copied Copy1 | client.interface.trigger("disableElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("disableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("disableElement", {id: "priority"}) |
| Source |
client.interface.trigger ("disableElement", {id: "source"}) |
| Impact |
client.interface.trigger ("disableElement", {id: "impact"}) |
| Urgency |
client.interface.trigger ("disableElement", {id: "urgency"}) |
| Type |
client.interface.trigger ("disableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("disableElement", {id: "agent"}) |
| Deparment |
client.interface.trigger ("disableElement", {id: "department"}) |
| Category |
client.interface.trigger ("disableElement", {id: "category"}) |
| Group |
client.interface.trigger ("disableElement", {id: "group"}) |
| custom field |
client.interface.trigger ("disableElement", {id: "customfield name"}) |
Enable Ticket Property Fields - This API displays the selected ticket property field with a preset value and this value will be editable.
The following table lists all the supported property fields:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("enableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("enableElement", {id: "priority"}) |
| Source |
client.interface.trigger ("enableElement", {id: "source"}) |
| Type |
client.interface.trigger ("enableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("enableElement", {id: "agent"}) |
| Deparment |
client.interface.trigger ("enableElement", {id: "department"}) |
| Category |
client.interface.trigger ("enableElement", {id: "category"}) |
| Group |
client.interface.trigger ("enableElement", {id: "group"}) |
| custom field |
client.interface.trigger ("enableElement", {id: "customfield name"}) |
Set Note type - This API enables you to set the note type to either private or public.
Copied Copy1 | client.interface.trigger("setValue", {id: "noteType", value: "value"}) |
1 | client.interface.trigger("setValue", {id: "noteType", value: "private"}) |
Start Timer - This API is used to start a timer.
Copied Copy1 | client.interface.trigger("start", {id: "timer", value: {agent: user_id, billable: true, note: "text"}}); |
Toggle Timer - This API is used to toggle a running/stopped timer.
Copied Copy1 | client.interface.trigger("toggle", {id: "timer", value:"value"}) |
Update Ticket Properties - This API is used to update and submit the Ticket Properties.
Copied Copy1 | client.interface.trigger("click", {id: "updateProperties"}) |
Change Details Page Interface
Change Page Interface Actions
The following APIs are available to all apps that are located in the change details page:- Hide Default Fields
- Show Default Fields
- Hide Planning Section
- Show Planning Section
- Disable Planning Section
- Enable Planning Section
- Hide Change Property Fields
- Show Change Property Fields
- Disable Change Property Fields
- Enable Change Property Fields
- Set Value for Change Property Fields
Hide status, priority, impact fields
Copied Copy1 | client.interface.trigger("hideElement", {id: "defaultFields"}) |
Show status, priority, impact fields
Copied Copy1 | client.interface.trigger("showElement", {id: "defaultFields"}) |
Hide Planning Section of Change view page
Copied Copy1 | client.interface.trigger("hideElement", {id: "planningFields"}) |
Show Planning Section of Change view page
Copied Copy1 | client.interface.trigger("showElement", {id: "planningFields"}) |
Disable Planning Section of Change view page
Copied Copy1 | client.interface.trigger("disableElement", {id: "planningFields"}) |
Enable Planning Section of Change view page
Copied Copy1 | client.interface.trigger("enableElement", {id: "planningFields"}) |
Hide Change Property Fields - This API hides the selected change properties field in the change details page.
Copied Copy1 | client.interface.trigger ("hideElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("hideElement", {id: "status"}) |
| Priority |
client.interface.trigger ("hideElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("hideElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("hideElement", {id: "risk"}) |
| Type |
client.interface.trigger ("hideElement", {id: "type"}) |
| Agent |
client.interface.trigger ("hideElement", {id: "agent"}) |
| Department |
client.interface.trigger ("hideElement", {id: "department"}) |
| Category |
client.interface.trigger ("hideElement", {id: "category"}) |
| Group |
client.interface.trigger ("hideElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("hideElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("hideElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("hideElement", {id: "customfield name"}) |
Show Change Property Fields - This API displays the selected change property field if hidden.
Copied Copy1 | client.interface.trigger ("showElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("showElement", {id: "status"}) |
| Priority |
client.interface.trigger ("showElement", {id: "priority"}) |
| Type |
client.interface.trigger ("showElement", {id: "type"}) |
| Impact |
client.interface.trigger ("showElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("showElement", {id: "risk"}) |
| Agent |
client.interface.trigger ("showElement", {id: "agent"}) |
| Department |
client.interface.trigger ("showElement", {id: "department"}) |
| Category |
client.interface.trigger ("showElement", {id: "category"}) |
| Group |
client.interface.trigger ("showElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("showElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("showElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("showElement", {id: "customfield name"}) |
Disable Change Property Fields - This API displays the selected change property field with a preset value and this value will be disabled for editing.
Copied Copy1 | client.interface.trigger("disableElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("disableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("disableElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("disableElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("disableElement", {id: "risk"}) |
| Type |
client.interface.trigger ("disableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("disableElement", {id: "agent"}) |
| Department |
client.interface.trigger ("disableElement", {id: "department"}) |
| Category |
client.interface.trigger ("disableElement", {id: "category"}) |
| Group |
client.interface.trigger ("disableElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("disableElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("disableElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("disableElement", {id: "customfield name"}) |
Enable Change Property Fields - This API displays the selected change property field with a preset value and this value will be editable.
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("enableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("enableElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("enableElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("enableElement", {id: "risk"}) |
| Type |
client.interface.trigger ("enableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("enableElement", {id: "agent"}) |
| Department |
client.interface.trigger ("enableElement", {id: "department"}) |
| Category |
client.interface.trigger ("enableElement", {id: "category"}) |
| Group |
client.interface.trigger ("enableElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("enableElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("enableElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("enableElement", {id: "customfield name"}) |
Set Value for Change Property Fields - This API displays the selected change property field with a preset value.
Copied Copy1 | client.interface.trigger("setValue", {id: "property", value: "value"}); |
The following table lists all the property fields for which default values can be set:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger("setValue", {id: "status", value: 3}) |
| Priority |
client.interface.trigger("setValue", {id: "priority", value: 3}) |
| Impact |
client.interface.trigger("setValue", {id: "impact", value: 2}) |
| Risk |
client.interface.trigger("setValue", {id: "risk", value: 2}) |
| Type |
client.interface.trigger("setValue", {id: "type", value: "2"}) |
| Group |
client.interface.trigger("setValue", {id: "group", value: "10"}) |
| Agent |
client.interface.trigger("setValue", {id: "agent", value: "30"}) |
| Department |
client.interface.trigger("setValue", {id: "department", value: "15"}) |
| Planned Start Date |
client.interface.trigger("setValue", {id: "plannedStartDate", value: "YYYY-MM-DDTHH:MM:SS±hh:mm"}) |
| Planned End Date |
client.interface.trigger("setValue", {id: "plannedEndDate", value: "YYYY-MM-DDTHH:MM:SS±hh:mm"}) |
| custom field |
client.interface.trigger("setValue", {id: "customfield name", value: 3}) |
New Ticket Page Interface
New Ticket Page Interface Actions
The following APIs are available to all apps that are located in the New Ticket page:- Hide Ticket Property Fields
- Show Ticket Property Fields
- Set Value for Ticket Property Fields
- Disable Ticket Property Fields
- Enable Ticket Property Fields
Hide Ticket Property Fields - This API hides the selected ticket properties field in the new ticket page.
Copied Copy1 | client.interface.trigger ("hideElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("hideElement", {id: "status"}) |
| Priority |
client.interface.trigger ("hideElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("hideElement", {id: "impact"}) |
| Urgency |
client.interface.trigger ("hideElement", {id: "urgency"}) |
| Type |
client.interface.trigger ("hideElement", {id: "type"}) |
| Agent |
client.interface.trigger ("hideElement", {id: "agent"}) |
| Department |
client.interface.trigger ("hideElement", {id: "department"}) |
| Category |
client.interface.trigger ("hideElement", {id: "category"}) |
| Group |
client.interface.trigger ("hideElement", {id: "group"}) |
| custom field |
client.interface.trigger ("hideElement", {id: "customfield name"}) |
Show Ticket Property Fields - This API displays the selected ticket property field if hidden.
Copied Copy1 | client.interface.trigger ("showElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("showElement", {id: "status"}) |
| Priority |
client.interface.trigger ("showElement", {id: "priority"}) |
| Type |
client.interface.trigger ("showElement", {id: "type"}) |
| Agent |
client.interface.trigger ("showElement", {id: "agent"}) |
| Department |
client.interface.trigger ("showElement", {id: "department"}) |
| Category |
client.interface.trigger ("showElement", {id: "category"}) |
| Group |
client.interface.trigger ("showElement", {id: "group"}) |
| custom field |
client.interface.trigger ("showElement", {id: "customfield name"}) |
Set Value for Ticket Property Fields - This API displays the selected ticket property field with a preset value.
Copied Copy1 | client.interface.trigger("setValue", {id: "property", value: "value"}); |
The following table lists all the property fields for which default values can be set:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger("setValue", {id: "status", value: 3}) |
| Priority |
client.interface.trigger("setValue", {id: "priority", value: 3}) |
| Ticket |
client.interface.trigger("setValue", {id: "type", value: "Incident"}) |
| Group |
client.interface.trigger("setValue", {id: "group", value: 10}) |
| Agent |
client.interface.trigger("setValue", {id: "agent", value: 30}) |
| Department |
client.interface.trigger("setValue", {id: "department", value: 1}) |
| custom field |
client.interface.trigger("setValue", {id: "customfield name", value: 3}) |
Disable Ticket Property Fields - This API displays the selected ticket property field with a preset value and this value will be disabled for editing.
Copied Copy1 | client.interface.trigger("disableElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("disableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("disableElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("disableElement", {id: "impact"}) |
| Urgency |
client.interface.trigger ("disableElement", {id: "urgency"}) |
| Type |
client.interface.trigger ("disableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("disableElement", {id: "agent"}) |
| Deparment |
client.interface.trigger ("disableElement", {id: "department"}) |
| Category |
client.interface.trigger ("disableElement", {id: "category"}) |
| Group |
client.interface.trigger ("disableElement", {id: "group"}) |
| custom field |
client.interface.trigger ("disableElement", {id: "customfield name"}) |
Enable Ticket Property Fields - This API displays the selected ticket property field with a preset value and this value will be editable.
The following table lists all the supported property fields:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("enableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("enableElement", {id: "priority"}) |
| Type |
client.interface.trigger ("enableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("enableElement", {id: "agent"}) |
| Deparment |
client.interface.trigger ("enableElement", {id: "department"}) |
| Category |
client.interface.trigger ("enableElement", {id: "category"}) |
| Group |
client.interface.trigger ("enableElement", {id: "group"}) |
| custom field |
client.interface.trigger ("enableElement", {id: "customfield name"}) |
New Change Page Interface
New Change Page Interface Actions
The following APIs are available to all apps that are located in the new change page:- Hide Planning Section
- Show Planning Section
- Disable Planning Section
- Enable Planning Section
- Hide Change Property Fields
- Show Change Property Fields
- Disable Change Property Fields
- Enable Change Property Fields
- Set Value for Change Property Fields
Hide Planning Section of New Change page
Copied Copy1 | client.interface.trigger("hideElement", {id: "planningFields"}) |
Show Planning Section of New Change page
Copied Copy1 | client.interface.trigger("showElement", {id: "planningFields"}) |
Disable Planning Section of New Change page
Copied Copy1 | client.interface.trigger("disableElement", {id: "planningFields"}) |
Enable Planning Section of New Change page
Copied Copy1 | client.interface.trigger("enableElement", {id: "planningFields"}) |
Hide Change Property Fields - This API hides the selected change properties field in the new change page.
Copied Copy1 | client.interface.trigger ("hideElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("hideElement", {id: "status"}) |
| Priority |
client.interface.trigger ("hideElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("hideElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("hideElement", {id: "risk"}) |
| Type |
client.interface.trigger ("hideElement", {id: "type"}) |
| Agent |
client.interface.trigger ("hideElement", {id: "agent"}) |
| Department |
client.interface.trigger ("hideElement", {id: "department"}) |
| Category |
client.interface.trigger ("hideElement", {id: "category"}) |
| Group |
client.interface.trigger ("hideElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("hideElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("hideElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("hideElement", {id: "customfield name"}) |
Show Change Property Fields - This API displays the selected change property field if hidden.
Copied Copy1 | client.interface.trigger ("showElement", {id: "element"}) |
The following table lists all the property fields that can be displayed:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("showElement", {id: "status"}) |
| Priority |
client.interface.trigger ("showElement", {id: "priority"}) |
| Type |
client.interface.trigger ("showElement", {id: "type"}) |
| Impact |
client.interface.trigger ("showElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("showElement", {id: "risk"}) |
| Agent |
client.interface.trigger ("showElement", {id: "agent"}) |
| Department |
client.interface.trigger ("showElement", {id: "department"}) |
| Category |
client.interface.trigger ("showElement", {id: "category"}) |
| Group |
client.interface.trigger ("showElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("showElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("showElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("showElement", {id: "customfield name"}) |
Disable Change Property Fields - This API displays the selected change property field with a preset value and this value will be disabled for editing.
Copied Copy1 | client.interface.trigger("disableElement", {id: "element"}) |
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("disableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("disableElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("disableElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("disableElement", {id: "risk"}) |
| Type |
client.interface.trigger ("disableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("disableElement", {id: "agent"}) |
| Department |
client.interface.trigger ("disableElement", {id: "department"}) |
| Category |
client.interface.trigger ("disableElement", {id: "category"}) |
| Group |
client.interface.trigger ("disableElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("disableElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("disableElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("disableElement", {id: "customfield name"}) |
Enable Change Property Fields - This API displays the selected change property field with a preset value and this value will be editable.
The following table lists all the property fields that can be hidden:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger ("enableElement", {id: "status"}) |
| Priority |
client.interface.trigger ("enableElement", {id: "priority"}) |
| Impact |
client.interface.trigger ("enableElement", {id: "impact"}) |
| Risk |
client.interface.trigger ("enableElement", {id: "risk"}) |
| Type |
client.interface.trigger ("enableElement", {id: "type"}) |
| Agent |
client.interface.trigger ("enableElement", {id: "agent"}) |
| Department |
client.interface.trigger ("enableElement", {id: "department"}) |
| Category |
client.interface.trigger ("enableElement", {id: "category"}) |
| Group |
client.interface.trigger ("enableElement", {id: "group"}) |
| Planned Start Date |
client.interface.trigger ("enableElement", {id: "plannedStartDate"}) |
| Planned End Date |
client.interface.trigger ("enableElement", {id: "plannedEndDate"}) |
| custom field |
client.interface.trigger ("enableElement", {id: "customfield name"}) |
Set Value for Change Property Fields - This API displays the selected change property field with a preset value.
Copied Copy1 | client.interface.trigger("setValue", {id: "property", value: "value"}); |
The following table lists all the property fields for which default values can be set:
| Element | Syntax |
|---|---|
| Status |
client.interface.trigger("setValue", {id: "status", value: 3}) |
| Priority |
client.interface.trigger("setValue", {id: "priority", value: 3}) |
| Impact |
client.interface.trigger("setValue", {id: "impact", value: 2}) |
| Risk |
client.interface.trigger("setValue", {id: "risk", value: 2}) |
| Type |
client.interface.trigger("setValue", {id: "type", value: "2"}) |
| Group |
client.interface.trigger("setValue", {id: "group", value: "10"}) |
| Agent |
client.interface.trigger("setValue", {id: "agent", value: "30"}) |
| Department |
client.interface.trigger("setValue", {id: "department", value: "15"}) |
| Planned Start Date |
client.interface.trigger("setValue", {id: "plannedStartDate", value: "YYYY-MM-DDTHH:MM:SS±hh:mm"}) |
| Planned End Date |
client.interface.trigger("setValue", {id: "plannedEndDate", value: "YYYY-MM-DDTHH:MM:SS±hh:mm"}) |
| custom field |
client.interface.trigger("setValue", {id: "customfield name", value: 3}) |