pp108 : GetTasksForUsers

GetTasksForUsers

This Web service operation lists the tasks available for the specific user based on the requested parameters.

SOAP Request

<GetTasksForUser merge="false" xmlns="http://schemas.cordys.com/task/1.0/runtime/">
    <User>cn=Jdoe,cn=organizational users,o=system,cn=cordys,o=vanenburg.com</User>
    <Type>UI_TASK</Type>
    <Parameters>
        <Parameter name="showOnStartPage" value="true"/>
    </Parameters>
</GetTasksForUser>
Request Parameters

Parameter

Description

Data Type

Accepted Input Values

User

User DN

String

Type

Task type details

String

UI_TASK
merge Filters the duplicate task details if it is assigned to more than one role of the specific user String true | false

Parameter

Parameter details for the task based on the name value pairs

XML Structure

For example, <Parameter name="showOnStartPage" value="true"/>


SOAP Response

<GetTasksForUserResponse xmlns="http://schemas.cordys.com/task/1.0/runtime/">
    <tuple>
        <old>
            <Task id="GUID of the task" name="name of task"
                type="UI_TASK" xmlns="http://schemas.cordys.com/task/1.0/">
                <Description>description about the task</Description>
                <Properties>
                    <Property name="showOnStartPage" value="true"/>
                </Properties>
                <Input/>
                <Output/>
                <LaunchingInfo>
                    <Application display="visible">
                        <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" isAvailable="true" name="name of task">
                        <Description>description of the task part</Description>
                    </TaskPart>
                    <TaskPart id="GUID of taskpart" isAvailable="false" name="name of task">
                        <Description>description of the task part</Description>
                    </TaskPart>
                </TaskParts>
                <RelatedTasks>
                    <Task id="GUID of the task" isAvialable="true" name="name of task"/>
                    <Task id="GUID of the task" isAvialable="false" name="name of task"/>
                </RelatedTasks>
            </Task>
        </old>
    </tuple>
    <tuple>
        <old>
            <Task xmlns="http://schemas.cordys.com/task/1.0/">.....</Task>
        </old>
    </tuple>
</GetTasksForUserResponse>
Response Parameters

Parameter

Description

Description

Description of the task

Property

Task details are provided based on the given parameters. It takes name value pairs. For example, <Property name="showOnStartPage" value="true"/>.

Input

Input data required for the task execution

Output

Result of the task execution

LaunchingInfo

Data required for launching an application

TaskPart

An activity that is a part of the task

RelatedTask

Task referred by the parent task