Close Change operation
The Close Change operation closes 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 Close Change operation
Element |
Definition |
Required |
---|---|---|
|
Specifies the name of the operation: |
Yes |
|
Contains the other elements in the request |
Yes |
|
Contains elements that uniquely identify a record |
Yes |
|
Specifies a unique record |
Yes |
|
Specifies the header information of the change record; is a structure-type element |
Yes |
|
Specifies the unique ID of a change record that is used as the key to identify the record |
No |
|
Specifies the category of the change record
|
No |
|
Specifies the status of a change
|
No |
|
Specifies the status of the approval for the change
|
No |
|
Specifies the name of the person who is requesting the change |
Conditional; required only if |
|
Specifies the name of the person to whom the change is assigned |
No |
|
Specifies the assignment group for the change |
No |
|
Specifies the name of the person coordinating the change |
No |
|
Specifies the phone number of the coordinator for the change |
No |
|
Specifies the planned start date of the change |
Yes |
|
Specifies the planned end date for the change |
Yes |
|
Specifies the reason for the change |
No |
|
Specifies the current phase of the change
|
No |
|
Specifies the risk assessment for the change
|
No |
|
Specifies the priority of the change as specified by the user who created the ticket |
No |
|
Specifies the date when the change record was entered into the system |
No |
|
Specifies whether the change record is in an open state
|
No |
|
Specifies the time required to roll back the change, if necessary |
No |
|
Specifies the date and time when the record was closed |
No |
|
Specifies the foreign ID of the change |
No |
|
Specifies the type of the request for change (RFC) |
No |
|
Specifies the name of the company |
No |
|
Specifies the title or a brief description of the change |
No |
|
Specifies the subcategory for the selected category |
No |
|
Specifies the Service Level Agreement (SLA) ID associated with the change |
No |
|
Specifies an array of descriptions for the change; is a structure type element |
Yes |
|
Specifies a description for the change; is an array-type element |
No |
|
Specifies the justification for the change; is an array-type element |
No |
|
Specifies the method to use to roll back the change, if necessary |
No |
|
Specifies an array of descriptions for the change; is a structure-type element |
Yes |
|
Specifies the configuration item associated with the change |
No |
|
Specifies the location associated with the change |
No |
|
Specifies miscellaneous information about the change |
No |
|
Specifies miscellaneous information about the change |
No |
|
Specifies the outage start date and time associated with the change |
No |
|
Specifies the outage end date and time associated with the change |
No |
|
Specifies the scheduled outage start date and time associated with the change |
No |
|
Specifies the scheduled outage end date and time associated with the change |
No |
|
Specifies the actual outage start date and time associated with the change |
No |
|
Specifies the actual outage end date and time associated with the change |
No |
|
Specifies a miscellaneous array element for the change |
No |
|
Specifies a miscellaneous array element for the change |
No |
|
Specifies a miscellaneous array element for the change |
No |
|
Specifies the configuration items associated with the change record; is an array-type element |
No |
|
Specifies the description of the estimate obtained for the change |
No |
|
Specifies the estimated price for implementing the change |
No |
|
Specifies the actual cost of implementing the change |
No |
|
Specifies the actual price for implementing the change |
No |
|
Contains elements that specify the closure details and comments for the change record; is a structure-type element |
Yes |
|
Specifies the completion code for the change |
No |
|
Specifies the closure comments for the change; is an array-type element |
No |
|
Specifies the level of urgency for the change
|
No |
|
Specifies the initial assessment of the change
|
No |
|
Specifies the service to be used for the change |
No |
|
Specifies the requested end date for the change |
No |
The following figure displays a sample adapter request for the Close Change operation.
Sample adapter request for the Close Change operation
<hp-service-manager-request>
<entity>change</entity>
<entity-type />
<request>
<operation-name>close-change</operation-name>
<parameters>
<close-change-request>
<model>
<keys>
<change-number>
<value>C10119</value>
<type>String</type>
</change-number>
</keys>
<instance>
<header>
<type>Structure</type>
<category>
<value>Hardware</value>
<type>String</type>
</category>
<status>
<value>closed</value>
<type>String</type>
</status>
<approval-status>
<value>approved</value>
<type>String</type>
</approval-status>
<requested-by>
<value>AARON, JIM</value>
<type>String</type>
</requested-by>
<assigned-to>
<value>FALCON</value>
<type>String</type>
</assigned-to>
<assignment-group>
<value>Application</value>
<type>String</type>
</assignment-group>
<coordinator>
<value>Conf.Coordinator</value>
<type>String</type>
</coordinator>
<coordinator-phone>
<value>11223366</value>
<type>String</type>
</coordinator-phone>
<planned-start-date>
<value>2009.11.01 08:00:00</value>
<type>DateTime</type>
</planned-start-date>
<planned-end-date>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</planned-end-date>
<reason>
<value>reason</value>
<type>String</type>
</reason>
<current-phase>
<value>Verification</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>2009.12.01 08:00:00</value>
<type>DateTime</type>
</date-entered>
<open>
<value>true</value>
<type>Boolean</type>
</open>
<backout-duration>
<value>PT0S</value>
<type>DurationType</type>
</backout-duration>
<close-time>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</close-time>
<foreign-i-d>
<value>FEG-123</value>
<type>String</type>
</foreign-i-d>
<r-f-c-type2>
<value>RFC-T2</value>
<type>String</type>
</r-f-c-type2>
<company>
<value>Advantage</value>
<type>String</type>
</company>
<brief-description>
<value>The Title for the Change</value>
<type>String</type>
</brief-description>
<subcategory>
<value>Login</value>
<type>String</type>
</subcategory>
<s-l-a-agreement-i-d>
<value>155</value>
<type>String</type>
</s-l-a-agreement-i-d>
</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>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>
<outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</outage-start>
<outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</outage-end>
<scheduled-outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</scheduled-outage-start>
<scheduled-outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</scheduled-outage-end>
<actual-outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</actual-outage-start>
<actual-outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</actual-outage-end>
<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>Adobe Reader</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>2010.01.31 12:30:00</value>
<type>DateTime</type>
</requested-date>
</instance>
</model>
</close-change-request>
</parameters>
</request>
</hp-service-manager-request>
The following figure displays an adapter response for the Close Change operation.
Sample adapter response for the Close 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>C10119</value>
<type>String</type>
</change-number>
</keys>
<instance>
<header>
<type>Structure</type>
<change-number>
<value>C10186</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>approved</value>
<type>String</type>
</approval-status>
<requested-by>
<value>AARON, JIM</value>
<type>String</type>
</requested-by>
<assigned-to>
<value>FALCON</value>
<type>String</type>
</assigned-to>
<assignment-group>
<value>Application</value>
<type>String</type>
</assignment-group>
<coordinator>
<value>Conf.Coordinator</value>
<type>String</type>
</coordinator>
<coordinator-phone>
<value>11223366</value>
<type>String</type>
</coordinator-phone>
<planned-start-date>
<value>2009.11.01 08:00:00</value>
<type>DateTime</type>
</planned-start-date>
<planned-end-date>
<value>2010.01.01 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.20 10:59:00</value>
<type>DateTime</type>
</date-entered>
<open>
<value>true</value>
<type>Boolean</type>
</open>
<backout-duration>
<value>PT0S</value>
<type>Duration</type>
</backout-duration>
<foreign-i-d>
<value>FEG-123</value>
<type>String</type>
</foreign-i-d>
<RFCType2>
<value>RFC-T2</value>
<type>String</type>
</RFCType2>
<company>
<value>Advantage</value>
<type>String</type>
</company>
<brief-description>
<value>The Title for the Change</value>
<type>String</type>
</brief-description>
<subcategory>
<value>Login</value>
<type>String</type>
</subcategory>
<SLAAgreement-i-d>
<value>155</value>
<type>Int</type>
</SLAAgreement-i-d>
<r-f-c-type2>
<value>RFC-T2</value>
<type>String</type>
</r-f-c-type2>
<s-l-a-agreement-i-d>
<value>155</value>
<type>Int</type>
</s-l-a-agreement-i-d>
</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>Adobe Reader</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>
<outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</outage-start>
<outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</outage-end>
<scheduled-outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</scheduled-outage-start>
<scheduled-outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</scheduled-outage-end>
<actual-outage-start>
<value>2009.12.01 08:00:00</value>
<type>DateTime</type>
</actual-outage-start>
<actual-outage-end>
<value>2010.01.01 08:00:00</value>
<type>DateTime</type>
</actual-outage-end>
<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>Adobe Reader</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>
</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>2010.01.31 12:30:00</value>
<type>DateTime</type>
</requested-date>
<uniquequery>header,number="C10119"</uniquequery>
<recordid>C10119 - The Title for the Change</recordid>
</instance>
</model>
<messages>
<element>
<value>Audit Record successfully recorded and added.</value>
</element>
<element>
<value>Change C10119 Phase Verification Closed by falcon j.</value>
</element>
<element>
<value>Change C10119 Phase Change Logging Opened by falcon.</value>
</element>
</messages>
<status>SUCCESS</status>
<message>Success</message>
<schema-revision-date>2010.01.19 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>
Comments
Log in or register to comment.