pp108 : GetTaskCollection

GetTaskCollection

Attribute detail is set to true in GetTaskCollection


This Web service operation takes the Task IDs and gives the task definitions for the requested tasks and also provides the detail attribute.

SOAP Request

<GetTaskCollection xmlns="http://schemas.cordys.com/task/1.0/runtime/">
    <Task detail="true" id="GUID of task"/>
    <Task detail="true" id="GUID of task"/>
</GetTaskCollection>


Request Parameters

Parameter

Description

Data Type

Accepted Input Values

Task

Provides the task details on the basis of input values.


  • detail - If detail is set to true, the complete Task definition is returned. If details is set to false, a partial task definition including task parts and related tasks is returned.
  • id - Unique ID of the task



SOAP Response

<GetTaskCollectionResponse
    xmlns="http://schemas.cordys.com/task/1.0/runtime/" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple>
        <old>
            <Task id="GUID of task" name="Name of the task"
                type="UI_TASK" xmlns="http://schemas.cordys.com/task/1.0/">
                <Description>The description about the task</Description>
                <Properties>
                    <Property name="showOnStartPage" value="true"/>
                </Properties>
                <Input/>
                <Output/>
                <LaunchingInfo>
                    <Application class="SoapProcessors" isfolder="false" menu="false">
                        <url>Url of the application</url>
                        <caption>Caption</caption>
                        <icon>url of the icon</icon>
                        <frame
                            features="dialogWidth:700px;dialogHeight:500px;center:yes"
                            height="%/px" left="%/px" top="%/px" width="%/px">main</frame>
                    </Application>
                </LaunchingInfo>
                <TaskParts>
                    <TaskPart id="GUID of taskpart" name="name of taskpart">
                        <Description>The description of the taskpart.</Description>
                    </TaskPart>
                    <TaskPart id="GUID of taskpart" name="name of taskpart">
                        <Description>The description of the taskpart.</Description>
                    </TaskPart>
                </TaskParts>
                <RelatedTasks>
                    <Task id="GUID of the task" name="name of the task"/>
                </RelatedTasks>
            </Task>
        </old>
    </tuple>
    <tuple>
        <old>
            <Task id="GUID of task" name="Name of the task"
                type="UI_TASK" xmlns="http://schemas.cordys.com/task/1.0/"/>
        </old>
    </tuple>
</GetTaskCollectionResponse>


Response Parameters

Parameter

Description

Description

The description about the task .

Property

Provides task details based on the given parameters. It takes name value pairs. Example: <Property name="showOnStartPage" value="true" /> .

Input

Input data required for execution of task.

Output

Result of execution of task.

LaunchingInfo

Data required for launching an application.

TaskPart

An activity that is part of the Task.

RelatedTask

Task referred by the parent task.


Attribute detail set to false in GetTaskCollection


SOAP Request

<GetTaskCollection xmlns="http://schemas.cordys.com/task/1.0/runtime/">
    <Task detail="false" id="GUID of the task"/>
    <Task detail="false" id="GUID of the task"/>
</GetTaskCollection>


Request Parameters

Parameter

Description

Data Type

Accepted Input Values

Task

Provides the task details on the basis of input values.


  • detail - If detail is set to true, the complete Task definition is returned. If details is set to false, a partial task definition including task parts and related tasks is returned.
  • id - Unique ID of the task



SOAP Response

<GetTaskCollectionResponse
    xmlns="http://schemas.cordys.com/task/1.0/runtime/" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple>
        <old>
            <Task id="GUID of the task" name="Monitor SOAP services"
                type="UI_TASK" xmlns="http://schemas.cordys.com/task/1.0/">
                <Description>Monitor SOAP Services</Description>
                <TaskParts>
                    <TaskPart id="GUID of the task part" name="name of the taskpart"/>
                    <TaskPart id="GUID of the task part" name="name of the taskpart"/>
                    <TaskPart id="GUID of the task part" name="name of the taskpart"/>
                </TaskParts>
                <RelatedTasks>
                    <Task id="GUID of the task" name="name of the task"/>
                </RelatedTasks>
            </Task>
        </old>
    </tuple>
    <tuple>
        <old>
            <Task id="GUID of the task" name="name of the task"
                type="Task Type" xmlns="http://schemas.cordys.com/task/1.0/">....</Task>
        </old>
    </tuple>
</GetTaskCollectionResponse>

Response Parameters

Parameter

Description

TaskPart

An activity that is part of the Task.

RelatedTask

Task referred by the parent task.


List all the available tasks in task repository


SOAP Request

<GetTaskCollection xmlns="http://schemas.cordys.com/task/1.0/runtime/"/>


SOAP Response

<GetTaskCollectionResponse
    xmlns="http://schemas.cordys.com/task/1.0/runtime/" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple>
        <old>
            <Task id="GUID of the task" name="name of the task"
                type="type of the task" xmlns="http://schemas.cordys.com/task/1.0/"/>
            <Task id="GUID of the task" name="name of the task"
                type="type of the task" xmlns="http://schemas.cordys.com/task/1.0/"/>
            <Task id="GUID of the task" name="name of the task"
                type="type of the task" xmlns="http://schemas.cordys.com/task/1.0/"/>
        </old>
    </tuple>
</GetTaskCollectionResponse>

Response Parameters

Parameter

Description

Data Type

Accepted Input Values

Task

Provides the task details on the basis of input values.


  • id - Unique ID of the task
  • name - Name of the task
  • type - Type of the task