TaskTicket Web-services

General

Mandatory input for each operation

• Credentials - Web Service Client User authentication credentials
• extendedSettings - Extended Settings such as response format.

Each Operation returns -

• DefaultServiceResponse JavaBean container which stores the specific bean response for Web Services operation

Notes:

• While creating an entity, values for fields such as Row ID (Unique system generated), Entity ID (System generated) should not be entered as input parameter values.
• While updating an entity, values for fields that already contain a Read only value should not be entered as input parameter values.

getTaskTicket

Id: 106  
Returns an excerpt of the primary details (general information) pertaining to the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier for which details should be fetched.

Output
Case ID, Case#, Row ID, Received In Mailbox, Ticket Type,
Contact Person, Requester Name, person1_address_id, Email, Requester Phone, person1_contact_id, Organization, Site, Location, person1_org_id, person2_address_id, Email, Phone, person2_contact_id, Organization, Site, Location, person2_org_id, vip_flag_person1, vip_flag_person2
qcktkt_id, tsk_flow_id, Task Name, Task Order, Task Type, Task Description, 
Affected Service ID, Affected Service, Category, Class, Item, Type, CCTI ID,
Impact, Impact Code, Prioritiy, Prioritiy Code, Source, Source Code, Urgency, Urgency Code,   
Phase, Status, Reason Code, Assigned Individual ID, Assigned Group ID, Assigned Group, Assigned Individual, Created By, Created On, Task Relevant Detailed Info, Closed By, Closed On, Modified By, Last Modified, 
Parent Symptom , Parent Ticket ID, Parent Ticket ID, Parent Ticket Identifier, Parent Ticket Type, 
Planned Duration (HH:MM), Planned End Date, Planned Start Date, Actual Duration (HH:MM), Actual End Date, Actual Start Date, Total Time Spent (HH:MM),  Custom fields with value

listTaskTickets

Id: 107   
Returns the list of all open task tickets for the logged in user and his groups matching the specified search criteria.

Input Parameters
searchText - String to match the Status, Assigned Group, Assigned Individual, Organization, Site etc.

Output
Assigned Group, Assigned Individual, Created Date, Requester Organization, Modified Date, Requester, Row ID, Case#, Description, Priority, Reason Code, Status, Type

createTaskTicket

Id: 108   
Creates the new task ticket with the provided details.

Input Parameters
taskBean - Task Ticket Bean containing details which must be used to create the ticket 
Row ID, Case#, Parent Row ID, Parent Case#, Case ID, Phase, Status, Reason Code, Assigned Individual, Assigned Contact ID, Assigned Group, Assigned Group ID, Created By, Modified By, Created On, Last Modified, Closed On, Closed By, Requester Contact ID, Requester Email, Requester Name, Requester Phone, Requester Organization, Requester Site, Requester Location, Requester Org ID, Requester Address ID, Vip Flag Person1, Requested For Contact ID, Requested For Email, Requested For, Requested For Phone, Requested For Organization, Requested For Site, Requested For Location, Requested For Org ID, Requested For Address ID, Vip Flag Person2, Affected Service ID, Affected Service Name, Affected Service Identifier, Task Description, Task Relevant Detailed Info, Source Code, Source, Priority Code, Priority, Urgency Code, Urgency, Impact Code, Impact, CCTI ID, Class, Category, Type, Item, Total Time Spent (HH,MM), Planned Start Date, Planned End Date, Planned Duration (HH,MM), Actual Start Date, Actual End Date, Actual Duration (HH,MM), Parent Symptom, Parent Ticket ID, Parent Ticket Type, qcktkt_id, Task Name, Task Order, Task Type, Task Flow ID, Alarm ID

Output
ticket_identifier, item_id

updateTaskTicket

Id: 109   
Updates an existing task ticket identified by the row id with the provided details.

Input Parameters
taskBean - Task Ticket Bean containing details which must be used to update the ticket
Row ID, Case#, Parent Row ID, Parent Case#, Case ID, Phase, Status, Reason Code, Assigned Individual, Assigned Contact ID, Assigned Group, Assigned Group ID, Created By, Modified By, Created On, Last Modified, Closed On, Closed By, Requester Contact ID, Requester Email, Requester Name, Requester Phone, Requester Organization, Requester Site, Requester Location, Requester Org ID, Requester Address ID, Vip Flag Person1, Requested For Contact ID, Requested For Email, Requested For, Requested For Phone, Requested For Organization, Requested For Site, Requested For Location, Requested For Org ID, Requested For Address ID, Vip Flag Person2, Affected Service ID, Affected Service Name, Affected Service Identifier, Task Description, Task Relevant Detailed Info, Source Code, Source, Priority Code, Priority, Urgency Code, Urgency, Impact Code, Impact, CCTI ID, Class, Category, Type, Item, Total Time Spent (HH,MM), Planned Start Date, Planned End Date, Planned Duration (HH,MM), Actual Start Date, Actual End Date, Actual Duration (HH,MM), Parent Symptom, Parent Ticket ID, Parent Ticket Type, qcktkt_id, Task Name, Task Order, Task Type, Task Flow ID, 

Output
ticket_identifier, item_id

listWorklogs

Id: 110
Returns the list of all the worklogs pertaining to the specified task ticket matching the specified search criteria.

Input Parameters
ticketIdentifier - Ticket Identifier for which worklogs should be fetched
searchText - String to match the User etc. 

Output
Row ID, Worklog Date, Created By, Created On, Worklog Description, Time Spent (Min), Work Log Type

addWorklog

Id: 111
Adds a new task  ticket specific worklog entry into the database and relates it to the respective ticket.

Input Parameters
workglogBean - Workglog Bean containing details which must be used to add the worklog.
Row ID, Ticket Identifier, Item ID, Ticket Type, Worklog Type Code, Worklog Type, Client Viewable,    
Time Spent (Min),  Worklog Description, Worklog Date, Work Created By, Work Created By Contact ID, Work Created Date, Work Modified By, Work Modified By Contact ID, Work Modified Date,   

Output
worklog_id

updateWorklog

Id: 112
Updates an existing task ticket specific worklog details.

Input Parameters
workglogBean - Workglog Bean containing details which must be used to update the worklog.
Row ID, Ticket Identifier, Item ID, Ticket Type, Worklog Type Code, Worklog Type, Client Viewable,    
Time Spent (Min),  Worklog Description, Worklog Date, Work Created By, Work Created By Contact ID, Work Created Date, Work Modified By, Work Modified By Contact ID, Work Modified Date,    

Output
worklog_id

listCommunications

Id: 113
Returns the list of all the communications pertaining to the specified task ticket matching the specified search criteria.

Input Parameters
ticketIdentifier - Ticket Identifier for which communications should be fetched
searchText - String to match the User etc.

Output
Created Date, Status, Communication ID, Send To, Subject, Direction, Type, Related To Form, Created By

sendCommunication

Id: 114 
Sends a new task ticket specific communication and relates it to the respective task ticket.

Input Parameters
commBean - Communication Bean containing details which must be used to send the communication.
Row ID / Ticket Identifier /Item ID / To/ Cc/ Bcc/ Subject/ Message/ Reply-To Display Name/ Communication Created By/ Do not deliver before/ Communication Delivery Status/Communication Template ID/ Communication Trace Log/ Communication Type/ Communication Type Mask/ Fb Form Notification ID/ Sched Task ID/ Regenerate message on Send.

Output
Communication_Id

listAttachments

Id: 115
Returns the list of all the related attachment document(s) matching the specified search criteria  pertaining to the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier for which attachments should be fetched.

Output
Created Date, Description, Attachment File Name, Type, Attachment ID, Can be used as Global, Attachment Name, Attachment Name, Created By, Case#, rel attach id, Ticket Type

relateAttachment

Id: 116
Relates specified attachment document to the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier to which a passed in Attachment is to be related.
attachmentId - Attachment Id which must be related to the change request.

Output
Attachment File Name, Attachment ID, Attachment Name, Can be used as Global, Case#, Created By,  Created Date, Description, Ticket Type, Type, rel attach id

unrelateAttachment

Id: 117
Unrelates specified attachment document associated with the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier from which an attachment is to be unrelated.
attachmentId - Attachment Id which must be related to the change request.

Output
None

listRelatedConfigurationItems

Id: 118
Returns the list of all the configuration items related to the specified task ticket matching the specified search criteria.

Input Parameters
ticketIdentifier - Ticket Identifier for which related Configuration Items should be fetched.

Output
CI ID, CI Name, Identifier, Purpose, Category, Class, Status, Attribute 1, Attribute 2, Attribute 3

relateConfigurationItem

Id: 119
Relates the Configuration Item (CI) identified by either the Row ID or CI Identifier (Row ID will take precedence over CI Identifier if both are specified) to the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier to which a passed in Configuration Item is to be related.
configurationItemIdentifier - Configuration Item Identifier which must be related to the change request.

Output
CI ID, Identifier, Name, Purpose, Status, Category, Class, Attribute 1, Attribute 2, Attribute 3 / 

unrelateConfigurationItem

Id: 120
Unrelates the Configuration Item (CI) identified by either the Row ID or CI Identifier (Row ID will take precedence over CI Identifier if both are specified) from the specified task ticket.

Input Parameters
ticketIdentifier - Ticket Identifier to which a passed in Configuration Item is to be related.
configurationItemIdentifier - Configuration Item Identifier which must be unrelated from the Task Ticket.

Output
None

listActivities

Id: 121
Returns the list of all historical activity including communications pertaining to the specified task ticket matching the specified search criteria.

Input Parameters
ticketIdentifier - Ticket Identifier for which historical activity should be fetched
searchText - String to match the Type, User etc.

Output
Case ID, User, Date, Description, history_row_id, Case#, Ticket Type, Type

listSLAComplianceLevels

Id: 122
Returns the list of all service level agreement (SLA) compliance being monitored, measured and acted upon for alters or escalations pertaining to the specified task ticket matching the specified search criteria.

Input Parameters
ticketIdentifier - Ticket Identifier for which service level agreement (SLA) compliances should be fetched
searchText - String to match the Target Name, Compliance Status etc.

Output
Agreement ID, SLA Compliance Target, Threshold, Violation Threshold, Due By , Start Time,  Due By, Measured Time, Threshold, Compliance Status, Affected Service, Assigned Group, Compliance Notes