Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article you will learn how to retrieve and create service operations using REST API. Service operations are the preconfigured set of actions that can be performed on a ticket using these methods. Using these you can also create any other operation using generic ODATA controller. The list of operations as follows.:

  • Create -TicketApproval
  • Create -sendCommunications
  • Create -updatePendingTickets
  • Retrieve -ChangeRequestsResolved
  • Retrieve -getAssignToList
  • Retrieve -getAssignToUserGroups
  • Retrieve -getPriorityList
  • Retrieve -getTicketsNotUpdated
  • Retrieve -getTicketsbacklog
  • Retrieve -getUnAssignedTickets
  • Retrieve -getUsers
  • Retrieve -listTicketsByLastModified
  • Retrieve -notifyApprovers
  • Retrieve -notifyApproversManager
  • Retrieve -notifyToManager
  • Retrieve -notifyToNextEsclationGroup
  • Retrieve -resetPassword
  • Retrieve -showMyTickets
  • Retrieve -showOrgTickets
  • Retrieve -showResolvedTickets
  • Retrieve -showTicketsApproachingSLA
  • Retrieve -ticketBacklog
  • Retrieve -ticketsWaitingForApproval
  • 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"
}

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",
"CommunicationTemplateID": "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"
}

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 service operations information, I general, you can perform the following steps in Swagger.:

  1. Click GET 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 Try it out to view the response.

You can validate the response by the response code displayed.

...