Service Operations

In this article you will learn how to retrieve and create service operations using the REST API. Below list provides the preconfigured set of actions that are configured to be performed on the tickets.

Note: All service operations are called in the same way. You can refer to the sections below to understand how to Create and retrieve data using the generic OData controller.

The list of operations as follows.:

  1. Create -TicketApproval
  2. Create -sendCommunications
  3. Create -updatePendingTickets
  4. Retrieve -ChangeRequestsResolved
  5. Retrieve -getAssignToList
  6. Retrieve -getAssignToUserGroups
  7. Retrieve -getPriorityList
  8. Retrieve -getTicketsNotUpdated
  9. Retrieve -getTicketsbacklog
  10. Retrieve -getUnAssignedTickets
  11. Retrieve -getUsers
  12. Retrieve -listTicketsByLastModified
  13. Retrieve -notifyApprovers
  14. Retrieve -notifyApproversManager
  15. Retrieve -notifyToManager
  16. Retrieve -notifyToNextEsclationGroup
  17. Retrieve -resetPassword
  18. Retrieve -showMyTickets
  19. Retrieve -showOrgTickets
  20. Retrieve -showResolvedTickets
  21. Retrieve -showTicketsApproachingSLA
  22. Retrieve -ticketBacklog
  23. Retrieve -ticketsWaitingForApproval
  24. Retrieve -validateCSMTenant

POST- Create Ticket Approval

To create ticket approval data, specify the following information in Swagger. 

  1. Click POST or Expand Operations to retrieve information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click the Example Value text box. The operations displayed in the text box will be copied to the approvalNotification text box.
  4. Click Try it out to view the response. The following information is displayed in the Example Value box.

Valid Attribute

{
"Comment": "string",
"CommentType": "string",
"ItemID": "string",
"MdrElementID": "string",
"MdrProdInstance": "string",
"MdrProduct": "string",
"RequestType": "string"
}

Sample Payload to send for Approving ticket 100-132


Sample Payload

{
"Comment": "This ticket is approved",
"CommentType": "Approved",
"ItemID": "100-132"
}

POST- Send Communications

To create send communications data, specify the required parameters as stated above, in Swagger. To copy the example value, perform the following:

  1. Click the Example Value text box. The operations displayed in the text box will be copied to the Communication text box.
  2. Click Try it out to view the response. The following information is displayed in the Example Value box.

Valid Attribute

{
"BCC": "string",
"CC": "string",
"CommunicationType": "string",
"CreationTimeStamp": "string",
"CreationUserName": "string",
"DeliveryStatus": "string",
"Direction": "string",
"FormID": "string",
"GenerateReport": "string",
"LocaleDisplayName": "string",
"LocaleID": "string",
"LocaleLangKey": "string",
"MdrElementID": "string",
"MdrProduct": "string",
"Message": "string",
"RegenerateMessageOnSend": "string",
"RelevanceItemID": "string",
"RelevanceItemType": "string",
"ReplyTo": "string",
"ReplyToDisplayName": "string",
"SendTo": "string",
"Subject": "string",
"TraceLog": "string"
}

Sample Payload to Send Email to recipients (testuser@acme.com and test@acme.com

{
"RelevanceItemID":"200-125",
"Message": "This is a test message",
"Subject": "This is a test",
"CC":"testuser@acme.com",
"SendTo":"testuser@acme.com"
}


POST- Update Pending Tickets

To create data related to update pending tickets, specify the required parameters as stated above, in Swagger. To copy the example value, perform the following:

  1. Click the Example Value text box. The operations displayed in the text box will be copied to the Communication text box.
  2. Click Try it out to view the response. The following information is displayed in the Example Value box.

Valid Attribute

{
"ClientViewable": "string",
"CreationTimestamp": "string",
"CreationUserID": "string",
"CreationUserName": "string",
"LastModTimestamp": "string",
"LastModUserID": "string",
"LastModUserName": "string",
"Text": "string",
"TicketID": "string",
"TicketIdentifier": "string",
"TicketType": "string",
"TimeSpent": "string",
"WorklogActualDate": "string",
"WorklogType": "string",
"WorklogTypeCode": "string",
"communicationSendCC": "string",
"communicationSendTo": "string",
"sendMail": "string"
}

Retrieve Service Operations

To retrieve the data from ISM use the appropriate service operations. you can perform the following steps in Swagger to check the response.:

  1. Click GET or Expand Operations to retrieve information for a specific operation.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click Try it out to view the response.

You can validate the response by the response code displayed.




© 2019 Serviceaide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com