Feature released in SummitAI Service Management (Denali HF01, Service Request Management)
What's New?
If the SR Workflow contains a Conditional Approval with the Approver set as User Selectable, you must specify the E-mail Id, Employee Id, or User Id of the Approver in the Log Service Request API. With this, the user can specify the Approver while raising an SR. The specified Approver receives a notification for the Approval of the Service Request.
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.
API Details
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"ServiceName": "SR_LogServiceRequestCatalog",
"objCommonParameters": {
"_ProxyDetails": {
"APIKey": "XXXXXXXXXXXXXXXXX",
"AuthType": "APIKEY",
"ProxyID": 0,
"TokenID": "",
"OrgID": "1",
"ReturnType": "JSON"
},
"SR_TicketParame": {
"Instance": "SRTent",
"ServiceCatalogID": "1747",
"LogSRForUserMode": true,
"RequesterEmailID": "Rest@test.com",
"SRRemarks": "This is just for testing - please ignore",
"CustomFields": [
{
"GroupName": "Test",
"AttributeName": "CheckBox",
"AttributeValue": "1"
}
],
"Approvals": [
{
"ApproverEmailId": "peter@xyz.com",
"ApproverEmpId": "Name",
"ApproverUserID": 0
}
]
}
}
}
|
| Note | ||
|---|---|---|
| ||
The API Request requires the Approvals section only when the SR Approval Workflow contains the Approver as User Selectable. |
Request Parameters
| Parameter Name | Type | Description | Notes | ||||||
|---|---|---|---|---|---|---|---|---|---|
Instance * |
| Name of the Instance. | |||||||
ServiceCatalogID * |
| Unique Identification of the Service Catalog. | |||||||
| LogSRForUserMode * |
| Is the SR logged for a user? | The value must always be true. | ||||||
| RequesterEmailID * |
| E-mail Id of the Requester. | |||||||
| SRRemarks |
| Remarks or comments about the SR. | |||||||
GroupName * |
| Group name of the Custom Field. | |||||||
AttributeName * |
| Type of the Custom Field. | |||||||
AttributeValue * |
| Value of the Custom Field. | |||||||
Approvals * |
| The User Selectable Approver details. | Specify any one of the following User Selectable Approver details:
| ||||||
| * Indicates mandatory fields | |||||||||
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"Errors": "",
"Input": null,
"Message": "Successfully saved the service request. Service Request ID: 2132",
"OrgID": 0,
"Output": null,
"OutputID": 0,
"OutputObject": null,
"TokenID": null,
"TicketID_Encrypted": null,
"TicketID_Internal": 2113,
"TicketNo": 2132
}
|
Prerequisites
- Create a Service Catalog. For more information, see Creating Service Catalogs
- Configure the Workflow with a Condition and Approver as User Selectable. For more information, see Configuring SR Approval Workflows.