GET /rest/bpm/wle/v1/activity/{activityInstanceId}/tasks
None
None
The default content type is application/json.
{
"status": "200",
"data": {"tasks": [ {
"activationTime": "2014-02-05T11:56:08Z",
"atRiskTime": "2014-02-05T12:50:08Z",
"clientTypes": ["IBM_WLE_Coach"],
"completionTime": null,
"containmentContextID": "53",
"description": "",
"displayName": "Step: AdHocActivity 1",
"dueTime": "2014-02-05T12:56:08Z",
"isAtRisk": false,
"kind": "KIND_PARTICIPATING",
"lastModificationTime": "2014-02-05T11:56:08Z",
"name": "AdHocActivity 1",
"originator": "tw_admin",
"owner": null,
"priority": 30,
"startTime": "2014-02-05T11:56:08Z",
"state": "STATE_READY",
"tkiid": "53",
"piid": "53",
"processInstanceName": "DemoCaseType:53",
"status": "Received",
"priorityName": "Normal",
"assignedTo": "All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.ae125e04-9c2a-43aa-80ed-ed8c53798a94",
"assignedToDisplayName": "All Users",
"assignedToType": "group",
"data": {"variables": {"variable1": null}},
"processData": {"businessData": []},
"serviceID": "1.c8d7cf04-ec94-43f8-aa57-d183e1c49503",
"flowObjectID": "ed6633a1-ed57-4cd7-8ab4-5b4bd04dc950",
"nextTaskId": null,
"collaboration": {
"status": false,
"currentUsers": []
}
}]}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/activity"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/activity"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:execution="http://rest.bpm.ibm.com/v1/data/execution"
xmlns:task="http://rest.bpm.ibm.com/v1/data/task">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
<import schemaLocation="Task.xsd" namespace="http://rest.bpm.ibm.com/v1/data/task"/>
<!--
This type contains details related to a activity instance.
-->
<complexType name="Activity">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The activity instance ID -->
<element name="id" type="string" />
<!-- The name of the activity -->
<element name="name" type="string" />
<!-- The current status of the activity instance
Valid values are:
"READY",
"WORKING",
"WAITING",
"DISABLED",
"LAUNCHING",
"SKIPPED",
"COMPLETED",
"FAILED",
"NOT_USED" -->
<element name="executionState" type="string" />
<!-- The task type of the activity instance
Valid values are:
"USER_TASK",
"CALLED_PROCESS",
"SUB_PROCESS" -->
<element name="activityType" type="string" />
<!-- The execution type of the activity instance
Valid values are:
"AUTOMATIC",
"MANUAL",
"NONE" -->
<element name="executionType" type="string" />
<!-- The option type of the activity instance
Valid values are:
"REQUIRED",
"OPTIONAL" -->
<element name="optionType" type="string" />
<!-- Indicates if the activity is required for completion. -->
<element name="required" type="boolean" />
<!-- Indicates if the activity is repeatable. -->
<element name="repeatable" type="boolean" />
<!-- The timestamp when the activity instance was started. -->
<element name="startTime" type="dateTime" nillable="true" />
<!-- The timestamp when the activity instance reached an end state. -->
<element name="endTime" type="dateTime" nillable="true" />
<!-- Indicates if the activity is hidden. -->
<element name="hidden" type="boolean" />
<!-- The ID of the document that enabled this activity, if any. -->
<element name="enablingDocumentID" type="string" nillable="true" />
<!-- The server name of the document that enabled this activity, if any. -->
<element name="enablingDocumentServerName" type="string" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
<!--
This type contains details related to a activity instance.
-->
<complexType name="ActivityDetails">
<complexContent>
<extension base="tns:Activity">
<sequence>
<!-- The due date associated with the activity -->
<element name="dueDate" type="dateTime" nillable="true" />
<!-- The id of the related task (only with user task implementation) -->
<element name="taskId" type="string" nillable="true" />
<!-- The owner's user id of the related task (only with user task implementation) -->
<element name="taskOwnerUserId" type="string" nillable="true" />
<!-- The owner's group id of the related task (only with user task implementation) -->
<element name="taskOwnerGroupId" type="string" nillable="true" />
<!-- The narrative of the activity -->
<element name="narrative" type="string" nillable="true" />
<!-- The type of the precondition -->
<element name="preconditionType" type="string" nillable="true" />
<!-- The precondition triggers -->
<element name="preconditionTriggers" type="tns:PreconditionTriggers" nillable="true" />
<!-- The precondition expressions -->
<element name="preconditionExpressions" type="tns:PreconditionExpressions" nillable="true" />
<!-- The precondition expressions display -->
<element name="preconditionExpressionsDisplay" type="tns:PreconditionExpressionsDisplay" nillable="true" />
<!-- The precondition expressions display -->
<element name="preconditionIsMatchAll" type="boolean" nillable="true" />
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of action names. -->
<complexType name="AvailableActions">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="actions" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of current tasks. -->
<complexType name="CurrentTasks">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="tasks" type="task:TaskDetails" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of precondition triggers. -->
<complexType name="PreconditionTriggers">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="triggers" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of precondition expressions. -->
<complexType name="PreconditionExpressions">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="expressions" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- A list of action names. -->
<complexType name="PreconditionExpressionsDisplay">
<complexContent>
<extension base="pref:Data">
<sequence>
<element name="expressionsDisplay" type="string" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</extension>
</complexContent>
</complexType>
</schema>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bpm:ResponseData xmlns:bpm="http://rest.bpm.ibm.com/v1/data">
<status>200</status>
<data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns8="http://rest.bpm.ibm.com/v1/data/activity" xsi:type="ns8:CurrentTasks">
<tasks>
<activationTime>2014-02-05T11:56:08Z</activationTime>
<atRiskTime>2014-02-05T12:50:08Z</atRiskTime>
<clientTypes>IBM_WLE_Coach</clientTypes>
<completionTime xsi:nil="true"/>
<containmentContextID>53</containmentContextID>
<description></description>
<displayName>Step: AdHocActivity 1</displayName>
<dueTime>2014-02-05T12:56:08Z</dueTime>
<isAtRisk>false</isAtRisk>
<kind>KIND_PARTICIPATING</kind>
<lastModificationTime>2014-02-05T11:56:08Z</lastModificationTime>
<name>AdHocActivity 1</name>
<originator>tw_admin</originator>
<owner xsi:nil="true"/>
<priority>30</priority>
<startTime>2014-02-05T11:56:08Z</startTime>
<state>STATE_READY</state>
<tkiid>53</tkiid>
<piid>53</piid>
<processInstanceName>DemoCaseType:53</processInstanceName>
<status>Received</status>
<priorityName>Normal</priorityName>
<assignedTo>All Users_T_da7e4d23-78cb-4483-98ed-b9c238308a03.ae125e04-9c2a-43aa-80ed-ed8c53798a94</assignedTo>
<assignedToDisplayName>All Users</assignedToDisplayName>
<assignedToType>group</assignedToType>
<data>
<variables>
<item key="variable1"/>
</variables>
</data>
<processData/>
<serviceID>1.c8d7cf04-ec94-43f8-aa57-d183e1c49503</serviceID>
<flowObjectID>ed6633a1-ed57-4cd7-8ab4-5b4bd04dc950</flowObjectID>
<collaboration>
<status>false</status>
</collaboration>
</tasks>
</data>
</bpm:ResponseData>
The default content type is application/json.
{ "description": "WLE Error Response",
"type": "object",
"properties":
{ "status": {"type": "string",
"description": "The status of the previous API call."
},
"exceptionType": {"type": "string",
"description": "The classname associated with the exception."
},
"errorNumber": {"type": "string",
"description": "Message ID of the exception."
},
"errorMessage": {"type": "string",
"description": "Message text of the exception."
},
"errorMessageParameters": {"type": ["string"], "optional": true,
"description":"Message text parameters of the exception."
},
"programmersDetails": {"type": "object", "optional": true,
"description":"Additional exception details, for example, a stack trace."
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/exception"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/exception"
xmlns:dat="http://rest.bpm.ibm.com/v1/data/root">
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root" />
<!--
This type represents an error response.
-->
<element name="RestRuntimeException">
<complexType>
<sequence>
<element name="status" type="string"/>
<element name="Data" type="tns:ExceptionData">
</element>
</sequence>
</complexType>
</element>
<!--
This type contains detailed error information associated with an exception.
-->
<complexType name="ExceptionData">
<sequence>
<element name="status" type="string"/>
<!-- This specifies the java class name of the exception -->
<element name="exceptionType" type="string"/>
<!-- The message ID of the error message -->
<element name="errorNumber" type="string" minOccurs="0"/>
<!-- The complete error message -->
<element name="errorMessage" type="string"/>
<!-- The list of strings inserted into the error message -->
<element name="errorMessageParameters" type="string" minOccurs="0" maxOccurs="unbounded"/>
<!--
The stacktrace associated with the exception.
Note that this will be omitted unless the "server-stacktrace-enabled" property
is enabled in the server's 100Custom.xml file.
-->
<element name="programmersDetails" type="string"></element>
<!-- Prior responses. Set if a bulk command was used -->
<element name="responses" type="dat:BulkCommandResponses" minOccurs="0"></element>
<element name="errorData" type="tns:ErrorData" minOccurs="0" />
</sequence>
</complexType>
<complexType name="ErrorData">
<sequence>
<element name="code" type="string" />
<element name="data" type="string" minOccurs="0" />
</sequence>
</complexType>
</schema>
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The activity instance does not exist.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred, programmer's details are provided. |
8.5.5
Parent Topic: Activity Instance (current tasks) Resource