Versions Compared

Old Version 5

changes.mady.by.user Richard Graves (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user sneha.tripathi

Saved on

Key

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

In this article you will learn how to retrieve, update, and create ticket such as Task, Problem, Service request, and Incident using the REST API.


Info
titleNote

The Ticket Controller is useful when searching for a ticket when you don't know the ticket type or retrieving a list of tickets of different types. If you are working with only one ticket type we recommend that you use that specific controller such as Change Request Controller, Incident Controller, Problem Controller or Service Request Controller 

GET- Ticket

To retrieve ticket information, you need to specify the required parameters in Swagger. To learn how to retrieve information using GET method, refer to REST API- GET Method Incident Controller

PUT- Ticket

To update ticket information, you need to specify the required parameters in Swagger. To learn how to edit the existing information using PUT method, perform the following.:

  1. Click PUT to edit the ticket 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 Ticket text box.
  4. Click Try it out. 
    The following information is displayed in the Example Value box.


Valid Ticket Attribute

{
"ActionId": "string",
"AffectedService": "string",
"AffectedServiceID": "string",
"ApprovalList": "string",
"AssignedCaseID": "string",
"AssignedContactID": "string",
"AssignedContactUserName": "string",
"AssignedGroup": "string",
"AssignedGroupID": "string",
"AssignedID": "string",
"AssignedIndividual": "string",
"AssignedIndividualExternalUserID": "string",
"AssignedIndividualID": "string",
"AssignedTo": "string",
"AutomatedFullfillmentDetailFields": "string",
"AutomationWFExecuteMode": "string",
"CasaWorkflowExecuteOnActionId": "string",
"CasaWorkflowInitiated": "string",
"Categorization": "string",
"CategorizationCategory": "string",
"CategorizationClass": "string",
"CategorizationID": "string",
"CategorizationItem": "string",
"CategorizationItems": "string",
"CategorizationType": "string",
"ClientViewable": "string",
"ClosedDateTimestamp": "string",
"ClosedGroupID": "string",
"ClosedGroupName": "string",
"ClosedUserName": "string",
"CreationById": "string",
"CreationGroupID": "string",
"CreationGroupName": "string",
"CreationTimestamp": "string",
"CreationUserName": "string",
"CustomAttributes": {},
"CustomFields": "string",
"CustomSearch": "string",
"Description": "string",
"DescriptionLong": "string",
"ExternalID": "string",
"GUID": "string",
"GlobalRelationshipType": "string",
"HasAttachments": "string",
"Impact": "string",
"ImpactCode": "string",
"IsArchived": "string",
"IsReadOnly": "string",
"IsSaveNExit": "string",
"LastModGroupID": "string",
"LastModGroupName": "string",
"LastModTimestamp": "string",
"LastModUserName": "string",
"LastWorklog": "string",
"LastWorklogDate": "string",
"LockedByExternalUserId": "string",
"LockedByUsername": "string",
"MdrElementID": "string",
"MetricKeysThrottled": "string",
"NonTranslatedParentTypeName": "string",
"NonTranslatedTicketStatus": "string",
"OrgStatus": "string",
"OverrideAutoRouting": "string",
"Phase": "string",
"Priority": "string",
"PriorityCode": "string",
"ProcessFlowID": "string",
"ProcessFlowIDStatus": "string",
"ProcessGUIFlowID": "string",
"ReadOnlyMsg": "string",
"ReasonCode": "string",
"RecentActivity": "string",
"RelatedCI": "string",
"RelatedCICount": 0,
"RequestCatalogAttachmentId": "string",
"RequestCatalogDescription": "string",
"RequestCatalogId": "string",
"RequestCatalogName": "string",
"RequestCatalogWorkflowId": "string",
"RequestedForAltEmail": "string",
"RequestedForAltPhone": "string",
"RequestedForExternalUserID": "string",
"RequestedForID": "string",
"RequestedForOrgHierarchicalPath": "string",
"RequestedForOrgLevel": "string",
"RequestedForOrgName": "string",
"RequestedForRootOrgId": "string",
"RequestedForRootOrgName": "string",
"RequestedForUserID": "string",
"RequestedForUserName": "string",
"RequestedForVIPFlag": "string",
"RequestedOrgID": "string",
"RequesterAltEmail": "string",
"RequesterAltPhone": "string",
"RequesterExternalUserID": "string",
"RequesterID": "string",
"RequesterOrgHierarchicalPath": "string",
"RequesterOrgID": "string",
"RequesterOrgLevel": "string",
"RequesterOrgName": "string",
"RequesterRootOrgId": "string",
"RequesterRootOrgName": "string",
"RequesterUserID": "string",
"RequesterUserName": "string",
"RequesterUserNameWithVIPFlag": "string",
"RequesterVIPFlag": "string",
"RequiresCabApproval": "string",
"ResolvedDateTimestamp": "string",
"ResolvedGroupID": "string",
"ResolvedGroupName": "string",
"ResolvedUserName": "string",
"SLAComplianceStatus": "string",
"SLADueTargetName": "string",
"SLADueTimestamp": "string",
"SLAHolidayID": "string",
"SLAResolveByTimestamp": "string",
"SLAStartDate": "string",
"SLATimezoneID": "string",
"SendWorklogEmail": "string",
"Source": "string",
"SourceCode": "string",
"SupportEmailAddress": "string",
"TenantId": "string",
"TicketAging": "string",
"TicketAgingRange": "string",
"TicketIdentifier": "string",
"TicketImagePath": "string",
"TicketStatus": "string",
"TicketTypeId": "string",
"TotalTimeSpent": "string",
"TranslatedSLAComplianceStatus": "string",
"TranslatedTypeName": "string",
"TwoRequests": "string",
"TypeName": "string",
"Urgency": "string",
"UrgencyCode": "string",
"VIPFlag": "string",
"WallTicketType": "string",
"WorkActualDate": "string",
"WorkDescription": "string",
"WorkTimeSpent": "string",
"WorkType": "string",
"WorkTypeCode": "string",
"WorklogActualDate": "string"
}

GET- Ticket/recent

To retrieve recent ticket information, you need to specify the required parameters in Swagger.:

  1. Click GET to retrieve recent ticket information
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
      - Specify the duration up to which period the data must be displayed.
  3. Click Try it out.


Info

To filter the tickets, pass the filter criteria in Query Parameters. For example, to view recent tickets for a specific 'Affected service' use $filter=(AffectedService=='Test') 

Image Added


GET- Ticket/{id}

To retrieve a specific ticket information, you need to specify the required parameters in Swagger. To learn how to retrieve information using GET method, refer to REST API- GET Method