API Enhancements in Incident Management
- Saranya S (Unlicensed)
- Shilpa K (Deactivated)
- Mayuresh Balaji Kamble (Unlicensed)
Feature released in SummitAI IT Service Management (Incident Management, Tahoe HF05)
What's New?
In the Incident Management module few APIs are enhanced for better usability.
The following APIs are enhanced:
- IM_GetMyIncidents
- IM_GetIncidentList
- PM_LogOrUpdatePR
API Name: IM_GetMyIncidents
The following parameters are included in the Retrieve My Incidents API:
- CallerEmailID
- strUpdatedFromDate
- strUpdatedToDate
You can apply additional filters such as caller email id and updated date using IM_GetMyIncidents API. Also, this API response contains the whole symptom of the ticket without any character limit.
Sample Request
{ "ServiceName": "IM_GetMyIncidents", "objCommonParameters": { "IncidentParam": { "CallerEmailID":"john@xyz.com", "Caller":0, "Executive": 0, "Workgroup": 0, "OrgID": "1", "CurrentPageIndex": 0, "Status": "OPEN", "PageSize": 20, "Instance": "Info", "strUpdatedFromDate":"", "strUpdatedToDate":"2022-01-20" }, "_ProxyDetails": { "AuthType": "APIKEY", "APIKey": "v55i0Q8G3wAlX1YmUG4aYVXz57T2buYztnQgUxySo2A=", "TokenID": "", "OrgID": "1", "ReturnType": "JSON", "ProxyID": 0 }, "InstanceCode": "Info" } }
Request Parameter
Parameter Name | Type | Description | Mandatory |
CallerEmailID | STRING | Email Id of the Caller. | FALSE |
strUpdatedFromDate | STRING | You can select the date range to get the list of Incidents. Specify the From Date of the Incidents starting from which, you want to retrieve the incidents. The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date. | FALSE |
strUpdatedToDate | STRING | You can select the date range to get the list of Incidents. Specify the To Date of the Incidents up till when you want to retrieve the incidents. The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date. | FALSE |
Sample Response
{ "Errors": "", "Message": "", "Output": "", "TokenID": "76AE1AD97B7FA0F7AA5338B92F995A529960BBE5554B217CF1C0E37F40CDB153B393D4568D9D8A601368ECA695EECE763561C42DD8257CC18A235DBBF258F017F58CD5DD59A5912F54F64583726C026BA56D0D4679539A32A490A02A48243EB2911B39E99184F66C9A04E84AEBC1A71E675B4B96212017691F90C8CDDE90B71B11A9DE877D2DB471E2C1B54D5307C15D3292F207ECF8F27A451A77B1B11AD5AEE4347C3090771CCC4AA6837A4253211C", "OrgID": 0, "OutputObject": { "MyTickets": [ { "ROWNUM": 1, "Ticket_ID": "cCZ50mBnhYgMXl9E0UNl2Q%3d%3d", "TotalRows": 2, "Incident ID": "48591", "Logged Time": "2022-01-20 05:05:44", "Status": "New", "Symptom": "Determined and independent, 1s are born leaders headed for success. Their charismatic personality means they have no trouble making new friends.Determined and independent, 1s are born leaders headed for success. Their charismatic they have no trouble they", "Workgroup Name": "CM workgroup", "Executive Name": "-", "Priority": "P5 ", "PriorityColorCode": null, "Resolution_SLA": 0, "SLAName": "24/7 Support", "CallerName": "rajnikanth pandey", "UserTypeColor": null, "UserTypeName": null, "Resolution_Time": null, "Age": 23, "Resolution_ElapseTime": 0, "SLAProgress": 0, "IsParentRecord": 0, "UserProfileImageName": "", "Pending": null, "GUID": "16762104-CE0D-4395-87CF-297C8F9EE21C", "Customer": "", "Location": "", "Resolution_Deadline": null, "Updated_Time": "2022-01-20 05:05:44", "SupFunctionID": "Info", "Sup_Function_Name": "Information Technology", "IsFeedbackEnabled": false, "IsFeedbackActive_IM": true, "AgeClass": "green", "AgingInfo": "0-2 Days", "SLAPercent": 0, "SLAProgressClass": null, "StatusCount": "New-2", "IsFeedBackProvided": 0, "TicketID_Internal": "29393" }, { "ROWNUM": 2, "Ticket_ID": "GlxvXHulUdwJEcfinLeGqQ%3d%3d", "TotalRows": 2, "Incident ID": "48590", "Logged Time": "2022-01-08 11:35:56", "Status": "New", "Symptom": "For the uninitiated, Umar Riaz was nominated for getting into a physical fight with Pratik Sehajpal. Umar during a task got into a fight with Pratik as the latter threw waFor the uninitiated, Umar Riaz was nominated threw waFor the uninitiateduninitiated", "Workgroup Name": "CM workgroup", "Executive Name": "-", "Priority": "P5 ", "PriorityColorCode": null, "Resolution_SLA": 0, "SLAName": "24/7 Support", "CallerName": "rajnikanth pandey", "UserTypeColor": null, "UserTypeName": null, "Resolution_Time": null, "Age": 305, "Resolution_ElapseTime": 0, "SLAProgress": 0, "IsParentRecord": 0, "UserProfileImageName": "", "Pending": null, "GUID": "70FB7647-664B-418E-BCAB-78F822152CFA", "Customer": "", "Location": "", "Resolution_Deadline": null, "Updated_Time": "2022-01-08 11:35:56", "SupFunctionID": "Info", "Sup_Function_Name": "Information Technology", "IsFeedbackEnabled": false, "IsFeedbackActive_IM": true, "AgeClass": "red", "AgingInfo": "More than 10 Days", "SLAPercent": 0, "SLAProgressClass": null, "StatusCount": "New-2", "IsFeedBackProvided": 0, "TicketID_Internal": "29392" } ], "GridViewDisplayColumns": [ { "LabelName": "Ticket_ID", "Value": "Ticket_ID", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Incident ID", "Value": "Incident ID", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Logged Time", "Value": "Logged Time", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Status", "Value": "Status", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Caller", "Value": "CallerName", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Workgroup", "Value": "Workgroup Name", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Symptom", "Value": "Symptom", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Pending Reason", "Value": "Pending", "Placeholder": null, "IsCustomField": false } ] }, "OutputID": 0, "Input": null }
API Name: IM_GetIncidentList
Now, the IM_GetIncidentList API response contains the whole symptom of the ticket without any character limit.
{ "ServiceName": "IM_GetIncidentList", "objCommonParameters": { "_ProxyDetails": { "AuthType": "APIKey", "APIKey":"v55i0Q8G3wAlX1YmUG4aYVXz57T2buYztnQgUxySo2A=", "ProxyID": 0, "ReturnType": "json", "OrgID": 1, "TokenID": "" }, "objIncidentCommonFilter": { "WorkgroupName": "", "CurrentPageIndex": 0, "PageSize": 2, "OrgID": "1", "Instance": "Info", "Status": "New,In-Progress", "strUpdatedFromDate": "2021-01-01", "strUpdatedToDate": "2022-06-26", "IsWebServiceRequest": true } } }
{ "Errors": "", "Message": "", "Output": "", "TokenID": "217E42334025AEBB573455055D730AA9C9A10F28629405BB44B3AD3BED7D64A29767B58E339C9863C5296C669E743438308F2AFB92A037D9F0A0CFF63D2F6689139D5D494975F34D1834ECF4525323DD6A779628C57571C2334E97CD2E9FCEC069B1BD0A16DA203223A90976190BEA4BFC3EA2C929D25D3A6AB54F88525FC47AD9C9EC522E52B17494A48405B412200A63572F302E6EAB2DC67622BBA52933E4EF80FC88EB9453E9066BC06BBE653AAE", "OrgID": 0, "OutputObject": { "MyTickets": [ { "ROWNUM": 1, "Ticket_ID": "cCZ50mBnhYgMXl9E0UNl2Q%3d%3d", "TotalRows": 7687, "Incident ID": 48591, "Logged Time": "2022-01-20 05:05:44", "Status": "New", "Symptom": "Determined and independent, 1s are born leaders headed for success. Their charismatic personality means they have no trouble making new friends.Determined and independent, 1s are born leaders headed for success. Their charismatic they have no trouble they", "Workgroup Name": "CM workgroup", "Executive Name": "", "Assigned_Engineer": null, "Priority": "P5 ", "PriorityColorCode": null, "Resolution_SLA": 0, "SLAName": "24/7 Support", "CallerName": "john", "UserTypeColor": null, "UserTypeName": null, "Resolution_Time": null, "Age": 23, "Resolution_ElapseTime": 0, "SLAProgress": 0, "IsParentRecord": 0, "UserProfileImageName": "", "CallerUpdate": null, "IsChild": 0, "IsParent": 0, "AssignedToMe": 0, "Reopened": false, "Sup_Function": "Info", "SLARemainingTime": 0, "Response_Deadline": "/Date(1642658160000)/", "Updated_Time": "2022-01-20 05:05:44", "Customer": null, "Location": null, "Urgency": "test1", "Impact": null, "Classification": null, "FullClassification": null, "Category": null, "FullCategory": null, "Pending Reason": null, "Schedule Date": null, "Service Window": "24/7 Support", "IsAttExists": 0, "IsAutoResolve": 0, "Vendor Incident ID": "", "Vendor Name": "", "Vendor_status": "", "VendorIncidentStartDate": null, "VendorIncidentEndDate": null, "Assigned_Engineer_Name_Secondary": "", "Response_voilation": null, "Resolution_voilation": null, "Response Deadline": "2022-01-20 09:26:00", "Resolution Deadline": null, "Reslution Code Name": null, "IsMajorIncident": "No", "AgeClass": "green", "AgingInfo": "0-2 Days", "SLAPercent": "0", "SLAProgressClass": null, "Remaining SLA Time": "", "Sub-Workgroup Name": null, "OpenCategory": null, "FullOpenCategory": null, "Resolution Time": null }, { "ROWNUM": 2, "Ticket_ID": "GlxvXHulUdwJEcfinLeGqQ%3d%3d", "TotalRows": 7687, "Incident ID": 48590, "Logged Time": "2022-01-08 11:35:56", "Status": "New", "Symptom": "For the uninitiated, Umar Riaz was nominated for getting into a physical fight with Pratik Sehajpal. Umar during a task got into a fight with Pratik as the latter threw waFor the uninitiated, Umar Riaz was nominated threw waFor the uninitiateduninitiated", "Workgroup Name": "CM workgroup", "Executive Name": "", "Assigned_Engineer": null, "Priority": "P5 ", "PriorityColorCode": null, "Resolution_SLA": 0, "SLAName": "24/7 Support", "CallerName": "john", "UserTypeColor": null, "UserTypeName": null, "Resolution_Time": null, "Age": 305, "Resolution_ElapseTime": 0, "SLAProgress": 0, "IsParentRecord": 0, "UserProfileImageName": "", "CallerUpdate": null, "IsChild": 0, "IsParent": 0, "AssignedToMe": 0, "Reopened": false, "Sup_Function": "Info", "SLARemainingTime": 0, "Response_Deadline": "/Date(1641644760000)/", "Updated_Time": "2022-01-08 11:35:56", "Customer": null, "Location": null, "Urgency": "test1", "Impact": null, "Classification": null, "FullClassification": null, "Category": null, "FullCategory": null, "Pending Reason": null, "Schedule Date": null, "Service Window": "24/7 Support", "IsAttExists": 0, "IsAutoResolve": 0, "Vendor Incident ID": "", "Vendor Name": "", "Vendor_status": "", "VendorIncidentStartDate": null, "VendorIncidentEndDate": null, "Assigned_Engineer_Name_Secondary": "", "Response_voilation": null, "Resolution_voilation": null, "Response Deadline": "2022-01-08 15:56:00", "Resolution Deadline": null, "Reslution Code Name": null, "IsMajorIncident": "No", "AgeClass": "red", "AgingInfo": "More than 10 Days", "SLAPercent": "0", "SLAProgressClass": null, "Remaining SLA Time": "", "Sub-Workgroup Name": null, "OpenCategory": null, "FullOpenCategory": null, "Resolution Time": null } ], "GridViewDisplayColumns": [ { "LabelName": "Ticket_ID", "Value": "Ticket_ID", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Incident ID", "Value": "Incident ID", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Logged Time", "Value": "Logged Time", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Status", "Value": "Status", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Caller", "Value": "CallerName", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Remaining SLA Time", "Value": "Remaining SLA Time", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Workgroup", "Value": "Workgroup Name", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Priority", "Value": "Priority", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Symptom", "Value": "Symptom", "Placeholder": null, "IsCustomField": false }, { "LabelName": "Pending Reason", "Value": "Pending Reason", "Placeholder": null, "IsCustomField": false } ] }, "OutputID": 0, "Input": null }
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ