Get Task List operation


The Get Task List operation enables you to retrieve a list of all the tasks owned by an organization. The top-level of your virtual infrastructure is called the organization.

The following figure shows a sample <items> XML element for the Get Task List operation:

Sample <items> XML element for the Get Task List operation

<items>
 <item>
   <parameters>
     <task-list-id></task-list-id>
   <parameters>
 </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Get Task List operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Get_Task_List

Yes

<vcloud-organization>

Specifies the name of the vCloud organization

Conditional:

  • Required if not specified in the configuration
  • If used, requires <user-name> and <password>
<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <password>
<password>

Contains the password corresponding to the specified user name

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <user-name>
<parameters>

Contains the elements for the operation

Yes

<task-list-id>

Specifies the ID of the task list whose information you want to retrieve
Valid value: Any string

Yes

The following figure shows the sample adapter request for the Get Task List operation:

Sample adapter request for the Get Task List operation

<vmware-vcloud-request>
 <operation-name>Get_Task_List</operation-name>
 <vcloud-organization>TestOrg</vcloud-organization>
 <user-name>TestUser</user-name>
 <password>Password</password>
 <parameters>
   <task-list-id>2001447251</task-list-id>
 </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample request:

Sample adapter response for the Get Task List operation

<vmware-vcloud-response>
 <metadata>
   <status>success</status>
 </metadata>
 <status-line>
   <code>200</code>
   <reason>OK</reason>
 </status-line>
 <message-body>
   <TasksList name="Tasks Lists" type="application/
vnd.vmware.vcloud.tasksList+xml"
href="https://10.128.248.112/api/v1.0/tasksList/2001447251">
<Task status="success" startTime="2010-11-24T12:07:28.438+05:30"
operation="Deleted Virtual Application
TestUser(1791436329)" expiryTime="2011-02-22T12:07:28.438+05:30"
Adapter requests and responses for the Task Management operations
Chapter 4 Actor adapter requests and responses 71
endTime="2010-11-24T12:07:28.976+05:30"
type="application/vnd.vmware.vcloud.task+xml" href="https://10.128.248.112/
api/v1.0/task/3tix7pq99rd9t5c4b92">
   <Owner type="application/vnd.vmware.vcloud.vApp+xml" name="TestUser"
href="https://10.128.248.112/api/v1.0/vApp/vapp-1791436329" />
   </Task>
   <Task status="success" startTime="2010-11-24T12:30:27.343+05:30"
operation="Composed Virtual Application
TestUser(1051223856)" expiryTime="2011-02-22T12:30:27.343+05:30"
endTime="2010-11-24T12:31:37.407+05:30"
type="application/vnd.vmware.vcloud.task+xml" href="https://10.128.248.112/
api/v1.0/task/1xbimgdnpu1bh2yhhe7">
   <Owner type="application/vnd.vmware.vcloud.vApp+xml" name="TestUser"
href="https://10.128.248.112/api/v1.0/vApp/vapp-1051223856" />
   </Task>
   <Task status="error" startTime="2010-11-24T17:11:49.695+05:30"
operation="Composed Virtual Application
TestUser(1599837103)" expiryTime="2011-02-22T17:11:49.695+05:30"
endTime="2010-11-24T17:12:56.714+05:30"
type="application/vnd.vmware.vcloud.task+xml" href="https://10.128.248.112/
api/v1.0/task/3az6i7wgp2cbwhayjun">
   <Owner type="application/vnd.vmware.vcloud.vApp+xml" name="TestUser"
href="https://10.128.248.112/api/v1.0/vApp/vapp-1599837103" />
<Error minorErrorCode="BAD_REQUEST" message="Unable to customize a
VM that either does not have VMware Tools installed
or has an older version that is unsupported. Temporarily disable guest
customization and upgrade the version of VMware tools for
the following VMs: "test'"." majorErrorCode="400" />
   </Task>
   <Task status="success" startTime="2010-11-24T22:04:57.363+05:30"
operation="Stopped Virtual Machine
TestVvAppVM1(244324925)" expiryTime="2011-02-22T22:04:57.363+05:30"
endTime="2010-11-24T22:05:16.990+05:30"
type="application/vnd.vmware.vcloud.task+xml" href="https://10.128.248.112/
api/v1.0/task/hkj4cmn5vdrqd361n7">
   <Owner type="application/vnd.vmware.vcloud.vm+xml"
name="TestVvAppVM1"
href="https://10.128.248.112/api/v1.0/vApp/vm-244324925" />
   </Task>
   </TasksList>
 </message-body>
</vmware-vcloud-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*