Close Interaction operation
The Close Interaction operation closes an interaction.
The following table describes the elements of the <items> XML element and the adapter request. If the valid value for an element is not specified, the valid value must be assumed to be a string.
Elements for the <items> XML element and adapter request for the Close Interaction operation
The following figure displays a sample adapter request for the Close Interaction operation.
Sample adapter request for the Close Interaction operation
<hp-service-manager-request>
<entity>servicedesk</entity>
<entity-type />
<request>
<operation-name>close-interaction</operation-name>
<parameters>
<close-interaction-request>
<model>
<keys>
<call-i-d>
<value>Incident1005</value>
<type>String</type>
</call-i-d>
</keys>
<instance>
<call-i-d>
<value>Incident1005</value>
<type>String</type>
</call-i-d>
<callback-contact>
<value>FALCON</value>
<type>String</type>
</callback-contact>
<notify-by>
<value>notify by</value>
<type>String</type>
</notify-by>
<category>
<value>incident</value>
<type>String</type>
</category>
<subcategory>
<value>performance</value>
<type>String</type>
</subcategory>
<product-type>
<value>system or application hangs</value>
<type>String</type>
</product-type>
<problem-type>
<value>none</value>
<type>String</type>
</problem-type>
<initial-impact>
<value>1</value>
<type>String</type>
</initial-impact>
<severity>
<value>1</value>
<type>String</type>
</severity>
<title>
<value>test title 2</value>
<type>String</type>
</title>
<description>
<type>Array</type>
<description>
<element>
<value>description line 1</value>
<type>String</type>
</element>
<element>
<value>description line 2</value>
<type>String</type>
</element>
</description>
</description>
<service>
<value>Handheld, PDA & Telephony</value>
<type>String</type>
</service>
<call-owner>
<value>Call owner</value>
<type>String</type>
</call-owner>
<status>
<value>Status</value>
<type>String</type>
</status>
<caller-department>
<value>caller deparment</value>
<type>String</type>
</caller-department>
<knowledge-candidate>
<value>true</value>
<type>Boolean</type>
</knowledge-candidate>
<SLAAgreement-i-d>
<value>1</value>
<type>Int</type>
</SLAAgreement-i-d>
<priority>
<value>1</value>
<type>String</type>
</priority>
<failed-entitlement>
<value>true</value>
<type>Boolean</type>
</failed-entitlement>
<resolution-code>
<value>resolution code</value>
<type>String</type>
</resolution-code>
<company>
<value>company</value>
<type>String</type>
</company>
<contact-name>
<value>FALCON</value>
<type>String</type>
</contact-name>
<reported-by-contact>
<value>FALCON</value>
<type>String</type>
</reported-by-contact>
<reported-by-different-contact>
<value>true</value>
<type>Boolean</type>
</reported-by-different-contact>
<location-full-name>
<value>location full name</value>
<type>String</type>
</location-full-name>
<entered-by-e-s-s>
<value>true</value>
<type>Boolean</type>
</entered-by-e-s-s>
<SLABreached>
<value>true</value>
<type>Boolean</type>
</SLABreached>
<update>
<type>Array</type>
<update>
<element>
<value>update line 1</value>
<type>String</type>
</element>
</update>
</update>
<s-l-a-agreement-i-d>
<value>1</value>
<type>Int</type>
</s-l-a-agreement-i-d>
<s-l-a-breached>
<value>true</value>
<type>Boolean</type>
</s-l-a-breached>
</instance>
</model>
</close-interaction-request>
</parameters>
</request>
</hp-service-manager-request>
The following figure displays an adapter response for the Close Interaction operation.
Sample adapter response for the Close Interaction operation
<hp-service-manager-response>
<metadata>
<count>1</count>
</metadata>
<responses>
<response>
<metadata>
<count>1</count>
</metadata>
<item>
<metadata>
<status>success</status>
</metadata>
<parameters>
<model>
<keys>
<call-i-d>
<value>Incident1005</value>
<type>String</type>
</call-i-d>
</keys>
<instance>
<call-i-d>
<value>Incident1005</value>
<type>String</type>
</call-i-d>
<contact-name>
<value>FALCON</value>
<type>String</type>
</contact-name>
<severity>
<value>1</value>
<type>String</type>
</severity>
<open-time>
<value>2010.02.07 16:23:10</value>
<type>DateTime</type>
</open-time>
<update-time>
<value>2010.02.09 16:13:25</value>
<type>DateTime</type>
</update-time>
<opened-by>
<value>falcon j</value>
<type>String</type>
</opened-by>
<description>
<type>Array</type>
<description>
<element>
<value>description line 1</value>
<type>String</type>
</element>
<element>
<value>description line 2</value>
<type>String</type>
</element>
</description>
</description>
<service>
<value>Handheld, PDA & Telephony</value>
<type>String</type>
</service>
<call-owner>
<value>Call owner</value>
<type>String</type>
</call-owner>
<status>
<value>Closed</value>
<type>String</type>
</status>
<notify-by>
<value>notify by</value>
<type>String</type>
</notify-by>
<category>
<value>incident</value>
<type>String</type>
</category>
<caller-department>
<value>caller deparment</value>
<type>String</type>
</caller-department>
<caller-location>
<value>caller location</value>
<type>String</type>
</caller-location>
<close-time>
<value>2010.02.09 15:50:54</value>
<type>DateTime</type>
</close-time>
<closed-by>
<value>falcon</value>
<type>String</type>
</closed-by>
<knowledge-candidate>
<value>true</value>
<type>Boolean</type>
</knowledge-candidate>
<SLAAgreement-i-d>
<value>168</value>
<type>Int</type>
</SLAAgreement-i-d>
<priority>
<value>1</value>
<type>String</type>
</priority>
<service-contract>
<value>1</value>
<type>Int</type>
</service-contract>
<site-category>
<value>site category</value>
<type>String</type>
</site-category>
<total-loss-of-service>
<value>true</value>
<type>Boolean</type>
</total-loss-of-service>
<subcategory>
<value>performance</value>
<type>String</type>
</subcategory>
<product-type>
<value>system or application hangs</value>
<type>String</type>
</product-type>
<problem-type>
<value>none</value>
<type>String</type>
</problem-type>
<failed-entitlement>
<value>true</value>
<type>Boolean</type>
</failed-entitlement>
<contact-location>
<value>contact location</value>
<type>String</type>
</contact-location>
<cause-code>
<value>cause code</value>
<type>String</type>
</cause-code>
<resolution-code>
<value>resolution code</value>
<type>String</type>
</resolution-code>
<company>
<value>company</value>
<type>String</type>
</company>
<reported-by-contact>
<value>FALCON</value>
<type>String</type>
</reported-by-contact>
<reported-by-different-contact>
<value>true</value>
<type>Boolean</type>
</reported-by-different-contact>
<reported-by-phone>
<value>reported by phone</value>
<type>String</type>
</reported-by-phone>
<reported-by-extension>
<value>reported by extension</value>
<type>String</type>
</reported-by-extension>
<reported-by-fax>
<value>reported by fax</value>
<type>String</type>
</reported-by-fax>
<contact-email>
<value>contact email</value>
<type>String</type>
</contact-email>
<location-full-name>
<value>location full name</value>
<type>String</type>
</location-full-name>
<contact-first-name>
<value>contact first name</value>
<type>String</type>
</contact-first-name>
<contact-last-name>
<value>contact last name</value>
<type>String</type>
</contact-last-name>
<contact-time-zone>
<value>contact time zone</value>
<type>String</type>
</contact-time-zone>
<entered-by-e-s-s>
<value>true</value>
<type>Boolean</type>
</entered-by-e-s-s>
<SLABreached>
<value>true</value>
<type>Boolean</type>
</SLABreached>
<callback-contact>
<value>FALCON</value>
<type>String</type>
</callback-contact>
<update>
<type>Array</type>
<update>
<element>
<value>02/09/10 03:19:28 US/Mountain (falcon):</value>
<type>String</type>
</element>
<element>
<value>update line 1</value>
<type>String</type>
</element>
</update>
</update>
<initial-impact>
<value>1</value>
<type>String</type>
</initial-impact>
<needed-by-time>
<value>2004.11.01 08:00:00</value>
<type>DateTime</type>
</needed-by-time>
<approval-status>
<value>approval status</value>
<type>String</type>
</approval-status>
<title>
<value>test title 2</value>
<type>String</type>
</title>
<uniquequery>incident.id="Incident1005"</uniquequery>
<recordid>Incident1005 - incident - description line 1</recordid>
<s-l-a-agreement-i-d>
<value>168</value>
<type>Int</type>
</s-l-a-agreement-i-d>
<s-l-a-breached>
<value>true</value>
<type>Boolean</type>
</s-l-a-breached>
</instance>
</model>
<messages>
<element>
<value>Interactions record closed.</value>
</element>
<element>
<value>Interaction Incident1005 has been closed.</value>
</element>
</messages>
<status>SUCCESS</status>
<message>Success</message>
<schema-revision-date>2005.03.15 00:00:00</schema-revision-date>
<schema-revision-level>0</schema-revision-level>
<return-code>0</return-code>
</parameters>
</item>
</response>
</responses>
</hp-service-manager-response>
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*