GET /rest/bpm/wle/v1/tasks[?savedSearch={string}][&fields={string}][&interaction={string}][&queryFilter={string}][&searchFilter={string}][&processAppName={string}][&sort={string}][&size={integer}][&offset={integer}][&filterByCurrentUser={boolean}][&calcStats={boolean}][&usersFullName={boolean}]
IBM.DEFAULTALLTASKSLIST_75 is executed.| Name | Value Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| savedSearch | string | Either the identifier (numeric) or the name (alphanumeric) of the saved search definition.
Note: To identify the correct saved search definition, you must specify either the name or the id parameter.The REST call interpretes the parameter value as follows:
|
||||||||||||
| fields | string | The comma-separated list of fields that is retrieved by the query. If no fields are specified, all the fields that are defined in the saved search definition are returned. Specify the field names in uppercase.
|
||||||||||||
| interaction | string | The name of a predefined user interaction filter. Overrides the interaction filter specified in the saved search.
Note: Using any of the interaction filter values in a saved search or as a query parameter on a saved search implies that the query filters by the current user, even if the user has IBM Business Automation Workflow Administrator rights on the server. The effect is the same as when the
|
||||||||||||
| queryFilter | string | This parameter is deprecated. Use the PUT method in Saved Search Execution instead.
A query table condition language expression (WHERE clause) that performs additional filtering on the result set. All attributes defined on the query can be referenced. Note: You can't use unary operators such as: 'IS NULL' or 'IS NOT NULL' on searchable business variables. Instead you can use the following expressions: '=null' or '<>null'. |
||||||||||||
| searchFilter | string | This search expression is used as input to the search engine. Note: This search expression is no longer used on a container environment.
See the Process Portal documentation for search tips. For a user with IBM Business Automation Workflow administrator rights on the server, this parameter only returns results under one of the following conditions:
Otherwise, an error occurs. |
||||||||||||
| processAppName | string | Name of the process application, used for additional filtering.
|
||||||||||||
| sort | string | A comma-separated list of sort criteria to apply to the results of the task query. The entries in the list are field names followed by an optional order in the form [FIELD_NAME ASC|DESC]. If no order is specified, the default order is Ascending(ASC). This list overrides the sort list specified in the saved search definition. The TAD_DESCRIPTION, STATE, and KIND attributes cannot be used within sort criteria.
|
||||||||||||
| size | integer | Specifies the maximum number of entities to be returned. If this number is not specified, the default size defined for the query is used.
|
||||||||||||
| offset | integer | Specifies the index (origin 0) of the first entity to be returned from the query result set.
Offset 0 refers to the first entity from the result set. Offset 1 refers to the second entity, and so on.
If no index is specified, the default value is 0.
|
||||||||||||
| filterByCurrentUser | boolean | This parameter is a flag that indicates whether the search results should be restricted to the entities that are
associated with the current user. If you set this parameter to Note: This parameter is used only when the request is executed by a user who belongs to the IBM Business Automation Workflow security group, otherwise it is ignored. |
||||||||||||
| calcStats | boolean | This parameter indicates whether the result should include tasks statistics. If the parameter is not specified, the default value is |
||||||||||||
| usersFullName | boolean | This parameter indicates whether the result should return user's login name or full name. If the parameter is not specified, the default value is |
The default content type is application/json.
{
"title":"Search Execution Result Set",
"type":"object",
"description":"This type represents the results of executing a saved or ad hoc search.",
"properties":
{ "identifier" : {"type": "string",
"description": "The key attribute associated with this set of query results. This will depend on the type of objects being returned by the query, and will be one of: TASK.TKIID, TASK_TEMPL.TKTID, PROCESS_INSTANCE.PIID."
},
"query": {"type": "string",
"description": "Name of the query that is associated with this query result set."
},
"entityTypeName": {"type": "string",
"description": "Type of entities that are returned as the result of the query. This will be one of PROCESS_INSTANCE, TASK, or TASK_TEMPL."
},
"queryExecuteTime": {"type": "dateTime",
"description": "The server timestamp when the search is run. Can be used by mobile devices to receive refresh notification. Can be null."
},
"taskIndexUpdateInterval ": {"type": "integer",
"description": "The server update interval of the task index."
},
"attributeInfo":{"type": "array",
"description":"The list of attributes (fields) returned by this query",
"properties": {
"name": {"type": "string",
"description": "Attribute name."
},
"type": {"type": "string",
"description": "Attribute type."
},
"isArray": {"type": "boolean",
"description": "Specifies whether the attribute has an array of values."
},
"content": {"type": "string",
"description": "A string that identifies attributes with a well-known value range."
},
"sourceAttribute": {"type": "string",
"description": "The related query table and attribute which provides this attributes' information."
},
"sourceQueryTableIdentifier": {"type": "string", "optional": true,
"description": "The ID of the source attribute's table, as defined in the query table definition."
}
}
},
"offset": {"type": "integer",
"description": "The offset value that was specified on the original request. This value represents the index (within the overall query result set) of the first item being returned"
},
"size": {"type": "integer",
"description": "The number of items being returned"
},
"requestedSize": {"type": "integer",
"description": "The number of items requested in the original request"
},
"totalCount": {"type": "integer",
"description": "Total number of results"
},
"countLimitExceeded": {"type": "boolean",
"description": "True if total number of results exceeds a search limit and is actually unknown"
},
"countLimit": {"type": "integer",
"description": "Specifies the search limit used if any or 0 if it's not set"
},
"items":{"type": "array",
"description":"The set of results returned by this query. This is represented as a list of zero or more items, where each item represents a row in the result set. Each item is represented by a Map, where the Map contains the various fields of data associated with that item (row).",
"properties": {
"key": {"type": "String",
"description": "The field."
},
"value": {"type": "anyType",
"description": "The value of that field."
}
}
},
"stats":{
"type": "array",
"description": "The summary stats for rows (items) in the result set that would be returned by executing a particular saved or adhoc search",
"properties": {
"total": {"type": "integer",
"description": "Total number of results."
},
"open": {"type": "integer",
"description": "Total number of results thare are open."
},
"onTrack": {"type": "integer",
"description": "Total number of results thare are onTrack."
},
"atRisk": {"type": "integer",
"description": "Total number of results thare are atRisk."
},
"overdue": {"type": "integer",
"description": "Total number of results thare are overdue."
}
}
}
}
}
{
"status":"200",
"data":{
"identifier":"TASK.TKIID",
"query":"IBM.DEFAULTALLTASKSLIST_75",
"entityTypeName":"TASK",
"queryExecuteTime": "2016-02-02T02:08:56Z",
"taskIndexUpdateInterval": 5,
"attributeInfo":[
{
"name":"SNAPSHOT_ID",
"type":"STRING",
"content":"PROCESS_INSTANCE.SNAPSHOT_ID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceSnapshotId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"DUE",
"type":"TIMESTAMP",
"content":"TASK.DUE",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskDueDate",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"ORIGINATOR",
"type":"STRING",
"content":"TASK.ORIGINATOR",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskReceivedFrom",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"COMPLETED",
"type":"TIMESTAMP",
"content":"TASK.COMPLETED",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskClosedDate",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PT_PTID",
"type":"ID",
"content":"PROCESS_INSTANCE.PTID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.bpdId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PI_NAME",
"type":"STRING",
"content":"PROCESS_INSTANCE.NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceName",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"AT_RISK_TIME",
"type":"TIMESTAMP",
"content":"TASK.AT_RISK_TIME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskAtRiskTime",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"KIND",
"type":"STRING",
"content":"TASK.KIND",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.WLE_TASK_MULTI_ATTRIBUTES",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"STATE",
"type":"STRING",
"content":"TASK.STATE",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskStatus",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"OWNER",
"type":"STRING",
"content":"TASK.OWNER",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.assignedToUser",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"OWNER_FULL_NAME",
"type":"STRING",
"content":"TASK.OWNER_FULL_NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.assignedToUserFullName",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"SNAPSHOT_NAME",
"type":"STRING",
"content":"PROCESS_INSTANCE.SNAPSHOT_NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceSnapshot",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PROCESS_APP_ACRONYM",
"type":"STRING",
"content":"PROCESS_INSTANCE.PROCESS_APP_ACRONYM",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceProcessApp",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PI_PIID",
"type":"ID",
"content":"PROCESS_INSTANCE.PIID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"ACTIVATED",
"type":"TIMESTAMP",
"content":"TASK.ACTIVATED",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskReceivedDate",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"STATUS",
"type":"STRING",
"content":"TASK.STATUS",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskStatus",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PRIORITY",
"type":"NUMBER",
"content":"TASK.PRIORITY",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskPriority",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"NAME",
"type":"STRING",
"content":"TASK.NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskActivityName",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TKIID",
"type":"ID",
"content":"TASK.TKIID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAD_DISPLAY_NAME",
"type":"STRING",
"content":"TASK_DESC.DISPLAY_NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskSubject",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"CONTAINMENT_CTX_ID",
"type":"ID",
"content":"TASK.CONTAINMENT_CTX_ID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"IS_AT_RISK",
"type":"BOOLEAN",
"content":"TASK.IS_AT_RISK",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskIsAtRisk",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"ASSIGNED_TO_ROLE_DISPLAY_NAME",
"type":"STRING",
"content":"TASK_DESC.ASSIGNED_TO_ROLE_DISPLAY_NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.assignedToRoleDisplayName",
"sourceQueryTableIdentifier":"n/a"
}
],
"offset": 0,
"size": 2,
"requestedSize": 2,
"totalCount": 11,
"countLimitExceeded":false,
"countLimit": 500,
"items":[
{
"TASK.TKIID": "3",
"PROCESS_INSTANCE.PIID": "3",
"SNAPSHOT_ID": "2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"DUE": "2016-01-29T17:52:07Z",
"ORIGINATOR": "tw_user",
"COMPLETED": "2016-01-29T16:52:30Z",
"PT_PTID": "25.f99618db-901f-487d-9917-f0aa6c811ab1",
"PI_NAME": "Employee Requisition for (3)",
"AT_RISK_TIME": "2016-01-30T17:46:07Z",
"KIND": "KIND_PARTICIPATING",
"STATE": "STATE_FINISHED",
"OWNER": "tw_user",
"SNAPSHOT_NAME": "1.0.1",
"PROCESS_APP_ACRONYM": "BPMRES1",
"PI_PIID": "3",
"ACTIVATED": "2016-01-29T16:52:07Z",
"STATUS": "Closed",
"PRIORITY": 30,
"NAME": "Submit job requisition",
"TKIID": "3",
"TAD_DISPLAY_NAME": "Task: Submit requisition",
"CONTAINMENT_CTX_ID": "3",
"IS_AT_RISK": true,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": null
},
{
"TASK.TKIID": "4",
"PROCESS_INSTANCE.PIID": "4",
"SNAPSHOT_ID": "2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"DUE": "2016-01-30T17:52:07Z",
"ORIGINATOR": "tw_user",
"COMPLETED": null,
"PT_PTID": "25.f99618db-901f-487d-9917-f0aa6c811ab1",
"PI_NAME": "Employee Requisition for (4)",
"AT_RISK_TIME": "2016-02-01T17:46:07Z",
"KIND": "KIND_PARTICIPATING",
"STATE": "STATE_CLAIMED",
"OWNER": "tw_user",
"SNAPSHOT_NAME": "1.0.1",
"PROCESS_APP_ACRONYM": "BPMRES1",
"PI_PIID": "4",
"ACTIVATED": "2016-01-30T16:52:07Z",
"STATUS": "Received",
"PRIORITY": 30,
"NAME": "Submit job requisition",
"TKIID": "3",
"TAD_DISPLAY_NAME": "Task: Submit requisition",
"CONTAINMENT_CTX_ID": "3",
"IS_AT_RISK": false,
"ASSIGNED_TO_ROLE_DISPLAY_NAME": null
}
],
"stats":{
"total": 11,
"open": 8,
"onTrack": 6,
"atRisk": 1,
"overdue": 1
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/savedsearchexecution"
elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://rest.bpm.ibm.com/v1/data/savedsearchexecution"
xmlns:common="http://rest.bpm.ibm.com/v1/data/common"
xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
xmlns:query="http://rest.bpm.ibm.com/v1/data/query">
<import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
<import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
<import schemaLocation="Query.xsd" namespace="http://rest.bpm.ibm.com/v1/data/query"/>
<!--
This type represents the results of executing a saved search.
-->
<!-- This type is used to return the results of executing a particular saved search definition. -->
<complexType name="SavedSearchResultSet">
<complexContent>
<extension base="pref:Data">
<sequence>
<!-- The key attribute associated with this set of query results. This
will depend on the type of objects being returned by the query, and will
be one of: "TASK.TKIID", "TASK_TEMPL.TKTID", "PROCESS_INSTANCE.PIID" -->
<element name="identifier" type="string" />
<!-- The name of the saved query for which these results were generated -->
<element name="query" type="string" />
<!-- This field indicates the type of objects are returned by this query.
This will be one of "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". -->
<element name="entityTypeName" type="string" />
<!-- The server timestamp when the search is run. Used by mobile devices to receive refresh notification -->
<element name="queryExecuteTime" type="dateTime" nillable="true" />
<!-- The server update interval of the task index -->
<element name="taskIndexUpdateInterval" type="integer" nillable="true" />
<!-- The list of attributes (fields, pre8570 aka columns ) returned by this query -->
<element name="attributeInfo" type="query:AttributeInfo"
minOccurs="0" maxOccurs="unbounded" />
<!-- The offset value that was specified on the original request. This
value represents the index (within the overall query result set) of the first
item being returned. -->
<element name="offset" type="integer" />
<!-- The number of items being returned -->
<element name="size" type="integer" />
<!-- The number of items requested in the original request -->
<element name="requestedSize" type="integer" />
<!-- Total number of results -->
<element name="totalCount" type="integer" />
<!-- True if total number of results exceeds a search limit and is actually unknown -->
<element name="countLimitExceeded" type="boolean" />
<!-- Specifies the search limit used if any or 0 if it's not set -->
<element name="countLimit" type="integer" />
<!-- The set of results returned by this query. This is represented
as a list of zero or more "items", where each item represents a row in the
result set. Each item is represented by a Map, where the Map contains the
various columns of data associated with that item (row). -->
<element name="items" type="common:Map" minOccurs="0" maxOccurs="unbounded" />
<!-- This type is used to return the stats for rows (items) in the result
set that would be returned by executing a particular saved query. -->
<element name="stats" type="query:QueryStats" />
</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:savedsrchexec='http://rest.bpm.ibm.com/v1/data/savedsearchexecution' xsi:type='savedsrchexec:SavedSearchResultSet'>
<identifier>TASK.TKIID</identifier>
<query>IBM.DEFAULTALLTASKSLIST_75</query>
<entityTypeName>TASK</entityTypeName>
<queryExecuteTime>2016-02-02T03:03:37Z</queryExecuteTime>
<attributeInfo>
<name>SNAPSHOT_ID</name>
<type>STRING</type>
<content>PROCESS_INSTANCE.SNAPSHOT_ID</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceSnapshotId</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>DUE</name>
<type>TIMESTAMP</type>
<content>TASK.DUE</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskDueDate</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>ORIGINATOR</name>
<type>STRING</type>
<content>TASK.ORIGINATOR</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskReceivedFrom</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>COMPLETED</name>
<type>TIMESTAMP</type>
<content>TASK.COMPLETED</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskClosedDate</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>PT_PTID</name>
<type>ID</type>
<content>PROCESS_INSTANCE.PTID</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.bpdId</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>PI_NAME</name>
<type>STRING</type>
<content>PROCESS_INSTANCE.NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceName</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>AT_RISK_TIME</name>
<type>TIMESTAMP</type>
<content>TASK.AT_RISK_TIME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskAtRiskTime</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>KIND</name>
<type>STRING</type>
<content>TASK.KIND</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.WLE_TASK_MULTI_ATTRIBUTES</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>STATE</name>
<type>STRING</type>
<content>TASK.STATE</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskStatus</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>OWNER</name>
<type>STRING</type>
<content>TASK.OWNER</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.assignedToUser</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>OWNER_FULL_NAME</name>
<type>STRING</type>
<content>TASK.OWNER_FULL_NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.assignedToUserFullName</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>SNAPSHOT_NAME</name>
<type>STRING</type>
<content>PROCESS_INSTANCE.SNAPSHOT_NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceSnapshot</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>PROCESS_APP_ACRONYM</name>
<type>STRING</type>
<content>PROCESS_INSTANCE.PROCESS_APP_ACRONYM</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceProcessApp</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>PI_PIID</name>
<type>ID</type>
<content>PROCESS_INSTANCE.PIID</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceId</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>ACTIVATED</name>
<type>TIMESTAMP</type>
<content>TASK.ACTIVATED</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskReceivedDate</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>STATUS</name>
<type>STRING</type>
<content>TASK.STATUS</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskStatus</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>PRIORITY</name>
<type>NUMBER</type>
<content>TASK.PRIORITY</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskPriority</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>NAME</name>
<type>STRING</type>
<content>TASK.NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskActivityName</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>TKIID</name>
<type>ID</type>
<content>TASK.TKIID</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskId</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>TAD_DISPLAY_NAME</name>
<type>STRING</type>
<content>TASK_DESC.DISPLAY_NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskSubject</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>CONTAINMENT_CTX_ID</name>
<type>ID</type>
<content>TASK.CONTAINMENT_CTX_ID</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceId</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>IS_AT_RISK</name>
<type>BOOLEAN</type>
<content>TASK.IS_AT_RISK</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskIsAtRisk</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<attributeInfo>
<name>ASSIGNED_TO_ROLE_DISPLAY_NAME</name>
<type>STRING</type>
<content>TASK.ASSIGNED_TO_ROLE_DISPLAY_NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.assignedToRoleDisplayName</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<offset>0</offset>
<size>2</size>
<requestedSize>2</requestedSize>
<totalCount>11</totalCount>
<countLimitExceeded>false</countLimitExceeded>
<countLimit>500</countLimit>
<items>
<item key='TASK.TKIID'>
<value xsi:type='ns10:string'>3</value>
</item>
<item key='PROCESS_INSTANCE.PIID'>
<value xsi:type='ns10:string'>3</value>
</item>
<item key='SNAPSHOT_ID'>
<value xsi:type='ns10:string'>2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</value>
</item>
<item key='DUE'>
<value xsi:type='ns10:string'>2016-01-29T17:52:07Z</value>
</item>
<item key='ORIGINATOR'>
<value xsi:type='ns10:string'>tw_user</value>
</item>
<item key='COMPLETED'>
<value xsi:type='ns10:string'>2016-01-29T16:52:30Z</value>
</item>
<item key='PT_PTID'>
<value xsi:type='ns10:string'>25.f99618db-901f-487d-9917-f0aa6c811ab1</value>
</item>
<item key='PI_NAME'>
<value xsi:type='ns10:string'>Employee Requisition for (3)</value>
</item>
<item key='AT_RISK_TIME'>
<value xsi:type='ns10:string'>2016-01-30T17:46:07Z</value>
</item>
<item key='KIND'>
<value xsi:type='ns10:string'>KIND_PARTICIPATING</value>
</item
<item key='STATE'>
<value xsi:type='ns10:string'>STATE_FINISHED</value>
</item>
<item key='OWNER'>
<value xsi:type='ns10:string'>tw_user</value>
</item>
<item key='SNAPSHOT_NAME'>
<value xsi:type='ns10:string'>1.0.1</value>
</item>
<item key='PROCESS_APP_ACRONYM'>
<value xsi:type='ns10:string'>BPMRES1</value>
</item>
<item key='PI_PIID'>
<value xsi:type='ns10:string'>3</value>
</item>
<item key='ACTIVATED'>
<value xsi:type='ns10:string'>2016-01-29T16:52:07Z</value>
</item>
<item key='STATUS'>
<value xsi:type='ns10:string'>Closed</value>
</item>
<item key='PRIORITY'>
<value xsi:type='ns10:int'>30</value>
</item>
<item key='NAME'>
<value xsi:type='ns10:string'>Submit job requisition</value>
</item>
<item key='TKIID'>
<value xsi:type='ns10:string'>3</value>
</item>
<item key='TAD_DISPLAY_NAME'>
<value xsi:type='ns10:string'>Task: Submit requisition</value>
</item>
<item key='CONTAINMENT_CTX_ID'>
<value xsi:type='ns10:string'>3</value>
</item>
<item key='IS_AT_RISK'>
<value xsi:type='ns10:boolean'>true</value>
</item>
<item key='ASSIGNED_TO_ROLE_DISPLAY_NAME'/>
</items>
<items>
<item key='TASK.TKIID'>
<value xsi:type='ns10:string'>4</value>
</item>
<item key='PROCESS_INSTANCE.PIID'>
<value xsi:type='ns10:string'>4</value>
</item>
<item key='SNAPSHOT_ID'>
<value xsi:type='ns10:string'>2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</value>
</item>
<item key='DUE'>
<value xsi:type='ns10:string'>2016-01-30T17:52:07Z</value>
</item>
<item key='ORIGINATOR'>
<value xsi:type='ns10:string'>tw_user</value>
</item>
<item key='COMPLETED'/>
<item key='PT_PTID'>
<value xsi:type='ns10:string'>25.f99618db-901f-487d-9917-f0aa6c811ab1</value>
</item>
<item key='PI_NAME'>
<value xsi:type='ns10:string'>Employee Requisition for (4)</value>
</item>
<item key='AT_RISK_TIME'>
<value xsi:type='ns10:string'>"2016-02-01T17:46:07Z</value>
</item>
<item key='KIND'>
<value xsi:type='ns10:string'>KIND_PARTICIPATING</value>
</item
<item key='STATE'>
<value xsi:type='ns10:string'>STATE_CLAIMED</value>
</item>
<item key='OWNER'>
<value xsi:type='ns10:string'>tw_user</value>
</item>
<item key='SNAPSHOT_NAME'>
<value xsi:type='ns10:string'>1.0.1</value>
</item>
<item key='PROCESS_APP_ACRONYM'>
<value xsi:type='ns10:string'>BPMRES1</value>
</item>
<item key='PI_PIID'>
<value xsi:type='ns10:string'>4</value>
</item>
<item key='ACTIVATED'>
<value xsi:type='ns10:string'>2016-01-30T16:52:07Z</value>
</item>
<item key='STATUS'>
<value xsi:type='ns10:string'>Received</value>
</item>
<item key='PRIORITY'>
<value xsi:type='ns10:int'>30</value>
</item>
<item key='NAME'>
<value xsi:type='ns10:string'>Submit job requisition</value>
</item>
<item key='TKIID'>
<value xsi:type='ns10:string'>4</value>
</item>
<item key='TAD_DISPLAY_NAME'>
<value xsi:type='ns10:string'>Task: Submit requisition</value>
</item>
<item key='CONTAINMENT_CTX_ID'>
<value xsi:type='ns10:string'>4</value>
</item>
<item key='IS_AT_RISK'>
<value xsi:type='ns10:boolean'>false</value>
</item>
<item key='ASSIGNED_TO_ROLE_DISPLAY_NAME'/>
</items>
<stats>
<total>11</total>
<open>8</open>
<onTrack>6</onTrack>
<atRisk>1</atRisk>
<overdue>1</overdue>
</stats>
</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 | Successful completion - requested data returned. Note that the list might be empty.
|
| 400 Bad Request | Bad Request
|
| 401 Unauthorized | The caller is not authorized for this request.
|
| 403 Forbidden | The caller is not authorized to perform this operation.
|
| 404 Not Found | The service could not be found.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | Internal Server Error. See the details provided.
|
8.5.7
Parent Topic: Search Execution Resource