Update Task operation
The Update Task operation updates a task 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. If no value is specified for a particular element or the element is skipped, the associated field will not be updated.
Elements for the <items> XML element and adapter request for the Update Task 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 number associated with a task |
No |
|
Specifies the category of the change record
|
No |
|
Specifies the status of a task
|
No |
|
Specifies the name of the person to whom the task is assigned |
No |
|
Specifies the department of the assignee for the task |
No |
|
Specifies the name of the person coordinating the task |
No |
|
Specifies the phone number of the coordinator for the change |
No |
|
Specifies the planned start date for the task |
No |
|
Specifies the planned end date for the task |
No |
|
Specifies the reason for the task |
No |
|
Specifies the phase of a task |
No |
|
Specifies the date when the task was created |
No |
|
Specifies whether the change record is in an open state
|
No |
|
Specifies the originator of the task |
No |
|
Specifies the change number of the parent change related to the task |
No |
|
Specifies the date on which the task was closed |
No |
|
Specifies the name of the company |
No |
|
Specifies the Service Level Agreement (SLA) ID of the task |
No |
|
Specifies an array of descriptions for the task; is a structure-type element |
Yes |
|
Specifies a description of the task; is an array-type element |
No |
|
Specifies an array of descriptions for the change; is a structure-type element |
Yes |
|
Specifies the product number of the task |
No |
|
Specifies the configuration item associated with the task |
No |
|
Specifies the location associated with the change task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies miscellaneous information about the task |
No |
|
Specifies the title or a brief description of the task |
No |
|
Specifies the date and time when the downtime related to the task started |
No |
|
Specifies the date and time when the downtime related to the task ended |
No |
|
Specifies the installation date for the task |
No |
|
Specifies a miscellaneous array element for the task |
No |
|
Specifies a miscellaneous array element for the task |
No |
|
Specifies the requested units for the task |
No |
|
Specifies the estimated price for implementing the change task |
No |
|
Specifies the actual units required for the task |
No |
|
Specifies the actual cost of implementing the change task |
No |
|
Specifies the actual price for implementing the task |
No |
|
Specifies whether the SLA related to the task was breached |
No |
|
Specifies the date when the SLA related to the task expires |
No |
|
Specifies whether the configuration item related to the task is down |
No |
|
Specifies whether the SLA was breached |
No |
|
Specifies whether the configuration item is down |
No |
|
Specifies the associated configuration item with the task change; is an array-type element |
No |
|
Specifies the closure information and comments for the task; is a structure-type element |
Yes |
|
Specifies the completion code for the task |
No |
|
Specifies the closure comments for the task; is an array-type element |
No |
|
Specifies the initial assessment of the change task
|
No |
|
Specifies the level of urgency for the change
|
No |
|
Specifies the date when the task was started |
No |
|
Specifies the date when the task ended |
No |
The following figure displays the sample adapter request for the Update Task operation.
Sample adapter request for the Update Task operation
<hp-service-manager-request>
<entity>change</entity>
<entity-type>task</entity-type>
<request>
<operation-name>update-change-task</operation-name>
<parameters>
<update-change-task-request>
<model>
<keys>
<task-number>
<value>Tsk-JS-001</value>
<type>String</type>
</task-number>
</keys>
<instance>
<header>
<type>Structure</type>
<parent-change>
<value>CHG-JS-002</value>
<type>String</type>
</parent-change>
</header>
<description-structure>
<type>Structure</type>
</description-structure>
<middle>
<type>Structure</type>
</middle>
<close>
<type>Structure</type>
</close>
</instance>
</model>
</update-change-task-request>
</parameters>
</request>
</hp-service-manager-request>
The following figure displays an adapter response for the Update Task operation.
Sample adapter response for the Update Task 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>
<task-number>
<value>Tsk-JS-001</value>
<type>String</type>
</task-number>
</keys>
<instance>
<header>
<type>Structure</type>
<task-number>
<value>Tsk-JS-001</value>
<type>String</type>
</task-number>
<category>
<value>Hardware</value>
<type>String</type>
</category>
<status>
<value>initial</value>
<type>String</type>
</status>
<assigned-to>
<value>assigned to</value>
<type>String</type>
</assigned-to>
<assignee-dept>
<value>assigned dept</value>
<type>String</type>
</assignee-dept>
<coordinator>
<value>coordinator</value>
<type>String</type>
</coordinator>
<coordinator-phone>
<value>coordinator phone</value>
<type>String</type>
</coordinator-phone>
<planned-start-date>
<value>2008.11.01 08:00:00</value>
<type>DateTime</type>
</planned-start-date>
<planned-end-date>
<value>2010.01.11 08:00:00</value>
<type>DateTime</type>
</planned-end-date>
<reason>
<value>reason</value>
<type>String</type>
</reason>
<phase>
<value>Hardware</value>
<type>String</type>
</phase>
<date-entered>
<value>2010.01.13 19:19:18</value>
<type>DateTime</type>
</date-entered>
<open>
<value>true</value>
<type>Boolean</type>
</open>
<originator>
<value>orginator</value>
<type>String</type>
</originator>
<parent-change>
<value>CHG-JS-002</value>
<type>String</type>
</parent-change>
<company>
<value>company</value>
<type>String</type>
</company>
<SLAAgreement-i-d>
<value>155</value>
<type>Int</type>
</SLAAgreement-i-d>
<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>description line 1</value>
<type>String</type>
</element>
<element>
<value>description line 2</value>
<type>String</type>
</element>
</description>
</description>
</description-structure>
<middle>
<type>Structure</type>
<product-number>
<value>product number</value>
<type>String</type>
</product-number>
<configuration-item>
<value>Exchange C</value>
<type>String</type>
</configuration-item>
<location>
<value>location</value>
<type>String</type>
</location>
<misc1>
<value>misc1</value>
<type>String</type>
</misc1>
...
<misc10>
<value>misc10</value>
<type>String</type>
</misc10>
<brief-description>
<value>brief description</value>
<type>String</type>
</brief-description>
<downtime-start>
<value>2008.11.01 08:00:00</value>
<type>DateTime</type>
</downtime-start>
<downtime-end>
<value>2010.01.11 08:00:00</value>
<type>DateTime</type>
</downtime-end>
<installation-date>
<value>2008.11.01 08:00:00</value>
<type>DateTime</type>
</installation-date>
<asset>
<type>Array</type>
<asset>
<element>
<value>SAP</value>
<type>String</type>
</element>
</asset>
</asset>
<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>
<requested-units>
<value>requested units</value>
<type>String</type>
</requested-units>
<estimate-price>
<value>estimate price</value>
<type>String</type>
</estimate-price>
<actual-units>
<value>actual units</value>
<type>String</type>
</actual-units>
<actual-cost>
<value>actual cost</value>
<type>String</type>
</actual-cost>
<actual-price>
<value>actual price</value>
<type>String</type>
</actual-price>
<SLABreached>
<value>true</value>
<type>Boolean</type>
</SLABreached>
<CIDown>
<value>true</value>
<type>Boolean</type>
</CIDown>
<s-l-a-breached>
<value>true</value>
<type>Boolean</type>
</s-l-a-breached>
<c-i-down>
<value>true</value>
<type>Boolean</type>
</c-i-down>
</middle>
<close>
<type>Structure</type>
<completion-code>
<value>1</value>
<type>Decimal</type>
</completion-code>
</close>
<initial-assessment>
<value>4</value>
<type>String</type>
</initial-assessment>
<urgency>
<value>4</value>
<type>String</type>
</urgency>
<actual-end-date>
<value>2010.01.11 08:00:00</value>
<type>DateTime</type>
</actual-end-date>
<actual-start-date>
<value>2010.01.15 12:30:00</value>
<type>DateTime</type>
</actual-start-date>
<uniquequery>header,number="Tsk-JS-001"</uniquequery>
<recordid>Tsk-JS-001 - Hardware - approved - brief description</recordid>
</instance>
</model>
<messages>
<element>
<value>Task Tsk-JS-001 Phase Hardware Updated by falcon j.</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>
Comments
Log in or register to comment.