Retract Change operation
The Retract Change operation retracts a change record.
The following table describes the elements of the <items> XML element and the adapter request. If not specified, the valid value for an element is assumed to be a string.
Elements for the <items> XML element and adapter request for the Retract Change operation
The following figure displays the sample adapter request for the Retract Change operation.
Sample adapter request for the Retract Change operation
<hp-service-manager-request>
<entity>change</entity>
<entity-type />
<request>
<operation-name>retract-change</operation-name>
<parameters>
<parameters> <retract-change-request>
<model>
<keys>
<change-number>
<value>C10098</value>
<type>String</type>
</change-number>
</keys>
<instance>
<header>
<type>Structure</type>
<category>
<value>Hardware</value>
<type>String</type>
</category>
<requested-by>
<value>AARON, JIM</value>
<type>String</type>
</requested-by>
<reason>
<value>reason</value>
<type>String</type>
</reason>
<current-phase>
<value>Change Logging</value>
<type>String</type>
</current-phase>
<risk-assessment>
<value>0</value>
<type>String</type>
</risk-assessment>
<brief-description>
<value>This should be the Title for the Change</value>
<type>String</type>
</brief-description>
<assignment-group>
<value>Application</value>
<type>String</type>
</assignment-group>
</header>
<description-structure>
<type>Structure</type>
<description>
<type>Array</type>
<description>
<!--zero or more array elements follow-->
<element>
<value>First Line of Description</value>
<type>String</type>
</element>
<element>
<value>Second Line of Description</value>
<type>String</type>
</element>
</description>
</description>
<justification>
<type>Array</type>
<justification>
<!--zero or more array elements follow-->
<element>
<value>justification line 1</value>
<type>String</type>
</element>
<element>
<value>justification line 2</value>
<type>String</type>
</element>
</justification>
</justification>
<backout-method>
<type>Array</type>
<backout-method>
<!--zero or more array elements follow-->
<element>
<value>back out method line 1</value>
<type>String</type>
</element>
<element>
<value>back out method line 2</value>
<type>String</type>
</element>
</backout-method>
</backout-method>
</description-structure>
<middle>
<type>Structure</type>
<configuration-item>
<value>MyDisplayDevice1</value>
<type>String</type>
</configuration-item>
<location>
<value>Location</value>
<type>String</type>
</location>
<misc1>
<value>misc1</value>
<type>String</type>
</misc1>
<misc2>
<value>misc2</value>
<type>String</type>
</misc2>
<misc-array1>
<type>Array</type>
<misc-array1>
<!--zero or more array elements follow-->
<element>
<value>misc array 1 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array 1 - 2</value>
<type>String</type>
</element>
</misc-array1>
</misc-array1>
<misc-array2>
<type>Array</type>
<misc-array2>
<!--zero or more array elements follow-->
<element>
<value>misc array 2 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array 2 - 2</value>
<type>String</type>
</element>
</misc-array2>
</misc-array2>
<misc-array3>
<type>Array</type>
<misc-array3>
<!--zero or more array elements follow-->
<element>
<value>misc array3 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array3 - 2</value>
<type>String</type>
</element>
</misc-array3>
</misc-array3>
<assets>
<type>Array</type>
<assets>
<!--zero or more array elements follow-->
<element>
<value>SDP</value>
<type>String</type>
</element>
</assets>
</assets>
<estimate-description>
<value>estimate description</value>
<type>String</type>
</estimate-description>
<estimate-price>
<value>estimate price</value>
<type>String</type>
</estimate-price>
<actual-cost>
<value>Actual Cost</value>
<type>String</type>
</actual-cost>
<actual-price>
<value>actual price</value>
<type>String</type>
</actual-price>
</middle>
<close>
<type>Structure</type>
<completion-code>
<value>5</value>
<type>Decimal</type>
</completion-code>
<closing-comments>
<type>Array</type>
<closing-comments>
<!--zero or more array elements follow-->
<element>
<value>closing comment line 1</value>
<type>String</type>
</element>
<element>
<value>closing comment line 2</value>
<type>String</type>
</element>
</closing-comments>
</closing-comments>
</close>
<urgency>
<value>1</value>
<type>String</type>
</urgency>
<initial-assessment>
<value>3</value>
<type>String</type>
</initial-assessment>
<service>
<value>Applications</value>
<type>String</type>
</service>
<requested-date>
<value>2009.12.31 12:30:00</value>
<type>DateTime</type>
</requested-date>
</instance>
</model>
</retract-change-request>
</parameters>
</request>
</hp-service-manager-request>
The following figure displays an adapter response for the Retract Change operation.
Sample adapter response for the Retract Change 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>
<change-number>
<value>C10098</value>
<type>String</type>
</change-number>
</keys>
<instance>
<header>
<type>Structure</type>
<change-number>
<value>C10098</value>
<type>String</type>
</change-number>
<category>
<value>Hardware</value>
<type>String</type>
</category>
<status>
<value>initial</value>
<type>String</type>
</status>
<approval-status>
<value>pending</value>
<type>String</type>
</approval-status>
<requested-by>
<value>AARON, JIM</value>
<type>String</type>
</requested-by>
<assignment-group>
<value>Application</value>
<type>String</type>
</assignment-group>
<coordinator>
<value>Change.Coordinator</value>
<type>String</type>
</coordinator>
<planned-start-date>
<value>2009.01.01 08:00:00</value>
<type>DateTime</type>
</planned-start-date>
<planned-end-date>
<value>2009.02.02 08:00:00</value>
<type>DateTime</type>
</planned-end-date>
<reason>
<value>reason</value>
<type>String</type>
</reason>
<current-phase>
<value>Change Logging</value>
<type>String</type>
</current-phase>
<risk-assessment>
<value>0</value>
<type>String</type>
</risk-assessment>
<priority>
<value>2</value>
<type>String</type>
</priority>
<date-entered>
<value>2010.01.19 12:52:05</value>
<type>DateTime</type>
</date-entered>
<open>
<value>true</value>
<type>Boolean</type>
</open>
<backout-duration>
<value>PT0S</value>
<type>Duration</type>
</backout-duration>
<company>
<value>advantage</value>
<type>String</type>
</company>
<brief-description>
<value>This should be the Title for the Change</value>
<type>String</type>
</brief-description>
<subcategory>
<value>Other</value>
<type>String</type>
</subcategory>
</header>
<description-structure>
<type>Structure</type>
<description>
<type>Array</type>
<description>
<element>
<value>First Line of Description</value>
<type>String</type>
</element>
<element>
<value>Second Line of Description</value>
<type>String</type>
</element>
</description>
</description>
<justification>
<type>Array</type>
<justification>
<element>
<value>justification line 1</value>
<type>String</type>
</element>
<element>
<value>justification line 2</value>
<type>String</type>
</element>
</justification>
</justification>
<backout-method>
<type>Array</type>
<backout-method>
<element>
<value>back out method line 1</value>
<type>String</type>
</element>
<element>
<value>back out method line 2</value>
<type>String</type>
</element>
</backout-method>
</backout-method>
</description-structure>
<middle>
<type>Structure</type>
<configuration-item>
<value>SDP</value>
<type>String</type>
</configuration-item>
<location>
<value>Location</value>
<type>String</type>
</location>
<misc1>
<value>misc1</value>
<type>String</type>
</misc1>
<misc2>
<value>misc2</value>
<type>String</type>
</misc2>
<misc-array1>
<type>Array</type>
<misc-array1>
<element>
<value>misc array 1 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array 1 - 2</value>
<type>String</type>
</element>
</misc-array1>
</misc-array1>
<misc-array2>
<type>Array</type>
<misc-array2>
<element>
<value>misc array 2 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array 2 - 2</value>
<type>String</type>
</element>
</misc-array2>
</misc-array2>
<misc-array3>
<type>Array</type>
<misc-array3>
<element>
<value>misc array3 - 1</value>
<type>String</type>
</element>
<element>
<value>misc array3 - 2</value>
<type>String</type>
</element>
</misc-array3>
</misc-array3>
<assets>
<type>Array</type>
<assets>
<element>
<value>SDP</value>
<type>String</type>
</element>
</assets>
</assets>
<estimate-description>
<value>estimate description</value>
<type>String</type>
</estimate-description>
<estimate-price>
<value>estimate price</value>
<type>String</type>
</estimate-price>
<actual-cost>
<value>Actual Cost</value>
<type>String</type>
</actual-cost>
<actual-price>
<value>actual price</value>
<type>String</type>
</actual-price>
</middle>
<close>
<type>Structure</type>
<completion-code>
<value>5</value>
<type>Decimal</type>
</completion-code>
<closing-comments>
<type>Array</type>
<closing-comments>
<element>
<value>closing comment line 1</value>
<type>String</type>
</element>
<element>
<value>closing comment line 2</value>
<type>String</type>
</element>
</closing-comments>
</closing-comments>
</close>
<urgency>
<value>1</value>
<type>String</type>
</urgency>
<initial-assessment>
<value>3</value>
<type>String</type>
</initial-assessment>
<service>
<value>Applications</value>
<type>String</type>
</service>
<requested-date>
<value>2009.12.31 12:30:00</value>
<type>DateTime</type>
</requested-date>
<uniquequery>header,number="C10098"</uniquequery>
<recordid>C10098 - This should be the Title for the Change</recordid>
</instance>
</model>
<messages>
<element>
<value>Change C10098 Phase Change Logging Retracted by Change.Approver.</value>
</element>
</messages>
<status>SUCCESS</status>
<message>Success</message>
<schema-revision-date>2010.01.15 00:00:00</schema-revision-date>
<schema-revision-level>5</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*