Date | Status | Change | Marked | By |
---|---|---|---|---|
29 MAY 2014 | To be reviewed | Created from previous xiwki document | ---- | Choksi |
Table of Contents | ||||
---|---|---|---|---|
|
General
Mandatory input for each 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.
getChangeRequest
Id: 7
Returns an excerpt of the primary details (general information) pertaining to the specified the change request.
Input Parameters
ticketIdentifier - Ticket Identifier for which details should be fetched
...
Actual Duration (HH:MM), Actual End Date, Actual Start Date, Affected Service ID, Affected Service, Action ID When Approved, Action ID When Rejected, Action When Approved, Action When Rejected, Approval Phase, Approval Status, Approval Type, Assigned Individual ID, Assigned Group ID, Assigned Group, Assigned Individual, Backout and Verification Plan, Business Criticality, Case ID, Category, Class, CCTI ID, Item, Type, Change Type, Created By, Created On, Environment Affected, Locations Affected, Closed By, Closed On, CIs Affected, Modified By, Last Modified, Change Impacted, Outage Duration (HH:MM), Outage Type, Parent Ticket ID, Parent Ticket Identifier, 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, Implementation and Verification Plan, Planned Duration (HH:MM), Planned End Date, Planned Start Date, Reason for Change, Requested For, Requester Name, Risk Assessment, Row ID, Received In Mailbox, Description of Change, Case#, Impact, Impact Code, Phase, Prioritiy, Prioritiy Code, Reason Code, Source, Source Code, Status, Urgency, Urgency Code, Total Time Spent (HH:MM), vip_flag_person1, vip_flag_person2, Affected Device, Employee Date of Birth, Employee Number, Memory_MultiLine, Alarm Checkbox, Priority_List, RadioButton, Working Hours, Suppression Key
listChangeRequests
Id: 8
Returns the list of all open change requests for the logged in user and his groups matching the specified search criteria.
Input Parameters
...
Assigned Group, Assigned Individual, Created Date, Requester Organization, Modified Date, Requester, Row ID, Case#, Description, Priority, Reason Code, Status, Type
createChangeRequest
Id: 9
Creates new change request with the provided details.
...
ticket_identifier, item_id
updateChangeRequest
Id: 10
Updates an existing change request with the provided details.
...
ticket_identifier, item_id
listWorklogs
Id: 11
Returns the list of all the worklogs pertaining to the specified change request matching the specified search criteria.
...
Row ID, Worklog Date, Created By, Created On, Worklog Description, Time Spent (Min), Work Log Type
addWorklog
Id: 12
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: 13
Adds a new ticket-specific worklog entry into the database and relates it to the respective change request.
...
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: 14
Returns the list of all the communications pertaining to the specified change request matching the specified search criteria.
Input Parameters
...
Created Date, Status, Communication ID, Send To, Subject, Direction, Type, Related To Form, Created By
sendCommunication
Id: 15
Sends a new ticket-specific communication and relates it to the respective ticket.
...
Row ID / Ticket Identifier /Item ID / To/ Cc/ Bcc/ Subject/ Message/ Reply-To/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: 16
Returns the list of all the related attachment document(s) matching the specified search criteria pertaining to the specified change request.
...
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: 17
Relates specified attachment document to the specified Change request.
...
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: 18
Unrelates specified attachment document associated with the specified change request.
...
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: 19
Returns the list of all the configuration items related to the specified support request (ticket) matching the specified search criteria .
...
Attribute 1, Attribute 2, Attribute 3, Category, Class, Purpose, CI ID, Identifier, Name, Status
relateConfigurationItem
Id: 20
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 change request.
...
Attribute 1 / Attribute 2 / Attribute 3 / CI ID / Category / Class / Identifier / Name / Purpose / Status
unrelateConfigurationItem
Id: 21
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 change request.
...
ticketIdentifier - Ticket Identifier to which a passed in Configuration Item is to be related.configurationItemIdentifier - Configuration Item Identifier which must be unrelated from the change request.
Output
None
listRelatedTickets
Id: 22
Returns the list of all the support requests (tickets) including task tickets related to the specified support request (ticket) matching the specified search criteria .
...
Case ID, rel_type_mask, Case#, Description, Other Information, Status, Ticket Type
relateTicket
Id: 23
Relates the selected support request (ticket) to a change request.
...
Case #, Description, Status, Other Information, Ticket Type, Case ID, rel_type_mask
unrelateTicket
Id: 24
Unrelates the specified support request (ticket) associated with a specified change request.
...
parentTicketIdentifier - Ticket Identifier from which a passed in Ticket is to be unrelated.relateTicketIdentifier - Ticket Identifier which must be unrelated from the change request.
Output
None
listActivities
Id: 25
Returns the list of all historical activity including communications pertaining to the specified change request matching the specified search criteria .
...
Case ID, User, Date, Description, history_row_id, Case#, Ticket Type, Type
listSLAComplianceLevels
Id: 26
Returns the list of all service level agreement (SLA) compliance being monitored, measured and acted upon for alters or escalations pertaining to the specified change request matching the specified search criteria.
...