Feature released in SummitAI Service Management (#28433, Sierra SP1 HF08, Service Request Management and Incident Management)
What's New?
Now, the following APIs are provided to retrieve the IM and SR list details:
Authentication
To authenticate the APIs, use the API login details. Create a user with the Login Type as API, generate an API Key to authenticate, and execute the APIs. For more information, see Adding Users.
Retrieving SR List Details
Use the following API request to retrieve the SR list details.
API Details
Request Parameters
| Parameter Name | Type | Description | Notes |
|---|---|---|---|
Executive | INTEGER | Is the requester an Analyst? | The value is 1, if the requester is an Analyst. |
WorkgroupName | STRING | Name of the Workgroup for which the required Incidents belong to. | You can get multiple workgroup Incidents by using comma separation between the workgroup names without a space. For Example: "WorkgroupName": "WG1,WG2,WG3" |
| CurrentPageIndex * | INTEGER | Current Index of the page that you are looking into. | For Example: If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the CurrentPageIndex value as 1. |
| PageSize * | INTEGER | Number of records that should be displayed per each page. | For Example: Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records. |
| OrgID * | INTEGER | Unique Identification number of the Organization. | The value must be always 1. |
Instance * | STRING | Name of the Instance. | For Example: Information Technology |
Status | STRING | Status of the Incidents that should be displayed. | Status can be Open, Reopened, New, Assigned, In-Progress, Pending, Resolved, Closed, and Cancelled. You can get all Incidents with different status' by using comma separation between the status names without a space. For Example: "Status": "Open,New,Assigned,In-Progress" |
strUpdatedFromDate | STRING | You can select the date range to get the list of Incidents. Specify the From Date of the Incidents that you want to be displayed. | The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date. |
strUpdatedToDate | STRING | You can select the date range to get the list of Incidents. Specify the To Date of the Incidents that you want to be displayed. | The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date. |
IsWebServiceRequest * | BOOLEAN | Is the Web Service is a Request or not? | By default the value is always true. |
Catalog * | INTEGER | Unique Identification number of the catalog. | |
CatalogName * | STRING | Name of the Catalog. | If both the Catalog and CatalogName values are specified, Catalog takes precedence over the CatalogName and displays the appropriate data in the response. |
IncludeCatalogAttributes * | BOOLEAN | Are the Catalog Attibutes required to be retrieved in the Response? |
|
| * Indicates mandatory fields | |||
Retrieving IM List Details
Use the following API request to retrieve the IM list details.
API Details
Request Parameters
| Parameter Name | Type | Description | Notes |
|---|---|---|---|
Executive | INTEGER | Is the requester an Analyst? | The value is 1, if the requester is an Analyst. |
WorkgroupName | STRING | Name of the Workgroup for which the required Incidents belong to. | You can get multiple workgroup Incidents by using comma separation between the workgroup names without a space. For Example: "WorkgroupName": "WG1,WG2,WG3" |
| CurrentPageIndex * | INTEGER | Current Index of the page that you are looking into. | For Example: If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the CurrentPageIndex value as 1. |
| PageSize * | INTEGER | Number of records that should be displayed per each page. | For Example: Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records. |
| OrgID * | INTEGER | Unique Identification number of the Organization. | The value must be always 1. |
Instance * | STRING | Name of the Instance. | For Example: Information Technology |
Status | STRING | Status of the Incidents that should be displayed. | Status can be Open, Reopened, New, Assigned, In-Progress, Pending, Resolved, Closed, and Cancelled. You can get all Incidents with different status' by using comma separation between the status names without a space. For Example: "Status": "Open,New,Assigned,In-Progress" |
strUpdatedFromDate | STRING | You can select the date range to get the list of Incidents. Specify the From Date of the Incidents that you want to be displayed. | The format of From Date is YYYY-MM-DD. The From Date starts from 00:00:00 hrs of the selected date. |
strUpdatedToDate | STRING | You can select the date range to get the list of Incidents. Specify the To Date of the Incidents that you want to be displayed. | The format of From Date is YYYY-MM-DD. The To Date ends on 11:59:59 hrs of the selected date. |
IsWebServiceRequest * | BOOLEAN | Is the Web Service is a Request or not? | By default the value is always true. |
CategoryName * | STRING | Name of the Category. | |
Categories * | STRING | Unique Identification numbers of the Category. | You can get different categories with by using comma separation between the Category IDs without a space. |
| * Indicates mandatory fields | |||
Note:
- Now, the Symptom in Response displays all characters without any restrictions.
- The file upload in multi-valued catalog attributes does not display the value. However, the attachment in single-valued attribute displays the attachment value.
- Based on the Pazesize configuration on the SUMMIT_AppConfigSettings file, the API request displays the records. Always the configuration done on the database takes precedence over value specified in the API request.