GetTasksForRoles |
Attribute detail is True
This Web service operation lists the tasks that are configured to the given roles. It takes a detail attribute with the role.
When detail attribute is set to true, task details including its task parts and related tasks information is given.
SOAP Request
<GetTasksForRoles xmlns="http://schemas.cordys.com/task/1.0/runtime/"> <Role detail="true" dn="cn=Maru,cn=organizational roles,o=system,cn=cordys,o=vanenburg.com"/> <Role detail="true" dn="cn=ABC,cn=organizational roles,o=system,cn=cordys,o=vanenburg.com"/> </GetTasksForRoles>
Request Parameters
Parameter |
Description |
Data Type |
Accepted Input Values |
---|---|---|---|
Role |
Provides information on the tasks assigned to a role. |
|
If detail is set to true, the complete task definition is returned. |
SOAP Response
<GetTasksForRoleResponse xmlns="http://schemas.cordys.com/task/1.0/runtime/"> <tuple> <old> <Role dn="" xmlns="http://schemas.cordys.com/task/1.0/"> <Task id="" name="" type="type of task"> <Description>The description of the task.</Description> <Properties> <Property name="" value=""/> </Properties> <Input/> <Output/> <LaunchingInfo/> <TaskParts> <TaskPart id="" name=""> <Description>The description of the task part</Description> </TaskPart> <TaskPart id="" name=""> <Description>The description of the task part</Description> </TaskPart> </TaskParts> <RelatedTasks> <Task id="" name=""/> <Task id="" name=""/> </RelatedTasks> </Task> <Task id="" name="" type="type of task"> <Description>The description of the task.</Description> <Properties> <Property name="" value=""/> </Properties> <Input/> <Output/> <LaunchingInfo/> <TaskParts> <TaskPart id="" name=""> <Description>The description of the task part</Description> </TaskPart> <TaskPart id="" name=""> <Description>The description of the task part</Description> </TaskPart> </TaskParts> <RelatedTasks> <Task id="" name=""/> <Task id="" name=""/> </RelatedTasks> </Task> </Role> </old> </tuple> <tuple> <old> <Role dn="" xmlns="http://schemas.cordys.com/task/1.0/"> <Task id="" name="" type="type of task">....</Task> </Role> </old> </tuple> </GetTasksForRoleResponse>
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 is False
When detail is set to false, it will list the task ids configured to that role only.
SOAP Request
<GetTasksForRoles xmlns="http://schemas.cordys.com/task/1.0/runtime/"> <Role detail="false" dn="cn=Maru,cn=organizational roles,o=system,cn=cordys,o=vanenburg.com"/> <Role detail="false" dn="cn=ABC,cn=organizational roles,o=system,cn=cordys,o=vanenburg.com"/> </GetTasksForRoles>
Request Parameters
Parameter |
Description |
Data Type |
Accepted Input Values |
---|---|---|---|
Role |
Provides information on the tasks assigned to a role. |
|
If detail is set to false, only the list of available tasks is returned. |
SOAP Response
<GetTasksForRolesResponse xmlns="http://schemas.cordys.com/task/1.0/runtime/"> <tuple> <old> <Role dn="" xmlns="http://schemas.cordys.com/task/1.0/"> <Task id="" name="" type="type of task"/> <Task id="" name="" type="type of task"/> <Task id="" name="" type="type of task"/> </Role> </old> </tuple> <tuple> <old> <Role dn="" xmlns="http://schemas.cordys.com/task/1.0/"> <Task id="" name="" type="type of task"/> <Task id="" name="" type="type of task"/> <Task id="" name="" type="type of task"/> </Role> </old> </tuple> </GetTasksForRolesResponse>
Response Parameters
Parameter |
Description |
---|---|
Task |
Provides the task details on the basis of input values. |