IBM Business Process Manager, Version 8.5.5
GET /rest/bpm/wle/v1/tasks/query/{queryName}[?selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&searchFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&filterByCurrentUser={boolean}]
| Name | Value Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| selectedAttributes | string | Comma-separated list of attributes that should be retrieved by the query. If no attributes are specified, then all of the attributes that are defined on the query are returned. Attribute names should be specified in upper-case.
|
||||||||||||||||
| interactionFilter | string | Name of a predefined user interaction.
Note: Using any of the interactionFilter values implies that the query filters by the current user, even if the user has administrative privileges. The effect is the same as if filterByCurrentUser is set to true.
|
||||||||||||||||
| queryFilter | string | 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.
|
||||||||||||||||
| searchFilter | string | A search expression used as input to the search engine.
For an administrative user this parameter only returns results if an interactionFilter is specified or the filterByCurrentUser parameter is set to true. Otherwise an error occurs.
|
||||||||||||||||
| processAppName | string | Name of the process application, used for additional filtering.
|
||||||||||||||||
| sortAttributes | string | Comma-separated list of sort criteria applied to the list of returned process instance entities. Each list entry has the form attribute [ASC|DESC] where ascending is the default. The attributes TAD_DESCRIPTION, STATE and KIND cannot be used within sort criteria.
|
||||||||||||||||
| 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 would refer to the second entity, and so on.
If this parameter is not specified, the default value of 0 is used.
|
||||||||||||||||
| size | integer | Specifies the maximum number of entities to be returned. If not specified, then the default size defined for the query will be used.
|
||||||||||||||||
| filterByCurrentUser | boolean | This parameter is a flag which indicates whether or not the search results should be restricted to those entities associated with the current user. A value of false means that an unfiltered search will be performed, whereas a value of true indicates that the search results will be filtered by the current user. If the current user is an administrative user, then the default is to perform a filtered search. If the current user is not an administrative user, then this parameter is ignored and a filtered search is performed. If not specified, the value defaults to false. Note: This parameter is used only when the request is being executed by a user belonging to the BPM security group, otherwise it is ignored. Note: In new client implementations, use the interactionFilter=ADMINISTER parameter setting. |
None
The default content type is application/json.
{ "description": "WLE Query Result Set",
"type": "object",
"properties":
{ "identifier" : {"type": "string",
"description": "Name of query result set attribute identifying an entity."
},
"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."
},
"attributeInfo":
[ { "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": "object",
"description": "Entities contained in this query result set; list of attribute names and values, as selected by selectedAttributes, plus the entities' key (using its source attribute name)."
}
]
}
}
{
"status":"200",
"data":{
"identifier":"TASK.TKIID",
"query":"IBM.DEFAULTALLTASKSLIST_75",
"entityTypeName":"TASK",
"attributeInfo":[
{
"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":"TKIID",
"type":"ID",
"content":"TASK.TKIID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PI_DISPLAY_NAME",
"type":"STRING",
"content":"PROCESS_INSTANCE.DISPLAY_NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceName",
"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":"SNAPSHOT_ID",
"type":"STRING",
"content":"PROCESS_INSTANCE.SNAPSHOT_ID",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.instanceSnapshotId",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"PRIORITY",
"type":"NUMBER",
"content":"TASK.PRIORITY",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskPriority",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"OWNER",
"type":"STRING",
"content":"TASK.OWNER",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.assignedToUser",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"KIND",
"type":"STRING",
"content":"TASK.KIND",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.WLE_TASK_MULTI_ATTRIBUTES",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"ORIGINATOR",
"type":"STRING",
"content":"TASK.ORIGINATOR",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskReceivedFrom",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"DUE",
"type":"TIMESTAMP",
"content":"TASK.DUE",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskDueDate",
"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":"NAME",
"type":"STRING",
"content":"TASK.NAME",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskActivityName",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"STATE",
"type":"STRING",
"content":"TASK.STATE",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskStatus",
"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":"STATUS",
"type":"STRING",
"content":"TASK.STATUS",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskStatus",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"ACTIVATED",
"type":"TIMESTAMP",
"content":"TASK.ACTIVATED",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskReceivedDate",
"sourceQueryTableIdentifier":"n/a"
},
{
"name":"TAD_DESCRIPTION",
"type":"STRING",
"content":"TASK_DESC.DESCRIPTION",
"isArray":false,
"sourceAttribute":"IBM.DEFAULTALLTASKSLIST_75.taskNarrative",
"sourceQueryTableIdentifier":"n/a"
}
],
"items":[
{
"CONTAINMENT_CTX_ID":"53",
"TASK.TKIID":"53",
"PRIORITY":30,
"SNAPSHOT_NAME":"1.0.1",
"NAME":"Submit job requisition",
"TKIID":"53",
"PI_DISPLAY_NAME":"Employee Requisition for (53)",
"TAD_DISPLAY_NAME":"Task: Submit requisition",
"ACTIVATED":"2011-04-28T03:20:13Z",
"PI_NAME":"Employee Requisition for (53)",
"STATE":"STATE_CLAIMED",
"STATUS":"Received",
"OWNER":"tw_user",
"TAD_DESCRIPTION":"Task: Submit requisition",
"KIND":"KIND_PARTICIPATING",
"DUE":"2011-04-28T04:20:12Z",
"PROCESS_APP_ACRONYM":"BPMRES1",
"SNAPSHOT_ID":"2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"PT_PTID":"25.8403dd37-e049-46f5-8952-b7a46f0d198f",
"PI_PIID":"53",
"ORIGINATOR":"tw_admin"
},
{
"CONTAINMENT_CTX_ID":"54",
"TASK.TKIID":"54",
"PRIORITY":30,
"SNAPSHOT_NAME":"1.0.1",
"NAME":"Submit job requisition",
"TKIID":"54",
"PI_DISPLAY_NAME":"Employee Requisition for (54)",
"TAD_DISPLAY_NAME":"Task: Submit requisition",
"ACTIVATED":"2011-04-28T03:23:43Z",
"PI_NAME":"Employee Requisition for (54)",
"STATE":"STATE_CLAIMED",
"STATUS":"Received",
"OWNER":"tw_user",
"TAD_DESCRIPTION":"Task: Submit requisition",
"KIND":"KIND_PARTICIPATING",
"DUE":"2011-04-28T04:23:43Z",
"PROCESS_APP_ACRONYM":"BPMRES1",
"SNAPSHOT_ID":"2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87",
"PT_PTID":"25.8403dd37-e049-46f5-8952-b7a46f0d198f",
"PI_PIID":"54",
"ORIGINATOR":"tw_admin"
},
{
"CONTAINMENT_CTX_ID":null,
"TASK.TKIID":"55",
"PRIORITY":30,
"SNAPSHOT_NAME":null,
"NAME":null,
"TKIID":"55",
"PI_DISPLAY_NAME":null,
"TAD_DISPLAY_NAME":"Submit Requisition",
"ACTIVATED":"2011-04-28T19:43:47Z",
"PI_NAME":null,
"STATE":"STATE_RUNNING",
"STATUS":"New",
"OWNER":"tw_user",
"TAD_DESCRIPTION":null,
"KIND":"KIND_ORIGINATING",
"DUE":"2011-05-03T19:43:47Z",
"PROCESS_APP_ACRONYM":null,
"SNAPSHOT_ID":null,
"PT_PTID":null,
"PI_PIID":null,
"ORIGINATOR":"tw_user"
},
{
"CONTAINMENT_CTX_ID":null,
"TASK.TKIID":"56",
"PRIORITY":30,
"SNAPSHOT_NAME":null,
"NAME":null,
"TKIID":"56",
"PI_DISPLAY_NAME":null,
"TAD_DISPLAY_NAME":"Submit Requisition",
"ACTIVATED":"2011-04-28T21:10:44Z",
"PI_NAME":null,
"STATE":"STATE_RUNNING",
"STATUS":"New",
"OWNER":"tw_user",
"TAD_DESCRIPTION":null,
"KIND":"KIND_ORIGINATING",
"DUE":"2011-05-03T21:10:44Z",
"PROCESS_APP_ACRONYM":null,
"SNAPSHOT_ID":null,
"PT_PTID":null,
"PI_PIID":null,
"ORIGINATOR":"tw_user"
},
{
"CONTAINMENT_CTX_ID":null,
"TASK.TKIID":"57",
"PRIORITY":30,
"SNAPSHOT_NAME":null,
"NAME":null,
"TKIID":"57",
"PI_DISPLAY_NAME":null,
"TAD_DISPLAY_NAME":"Submit Requisition",
"ACTIVATED":"2011-04-28T21:12:29Z",
"PI_NAME":null,
"STATE":"STATE_RUNNING",
"STATUS":"New",
"OWNER":"tw_user",
"TAD_DESCRIPTION":null,
"KIND":"KIND_ORIGINATING",
"DUE":"2011-05-03T21:12:29Z",
"PROCESS_APP_ACRONYM":null,
"SNAPSHOT_ID":null,
"PT_PTID":null,
"PI_PIID":null,
"ORIGINATOR":"tw_user"
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?> <schema targetNamespace="http://rest.bpm.ibm.com/v1/data/query" elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://rest.bpm.ibm.com/v1/data/query" xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common" xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"> <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" /> <!-- This type is used to return a list of saved queries. --> <complexType name="QueryList"> <complexContent> <extension base="pref:Data"> <sequence> <element name="identifier" type="string" /> <!-- This is a list of zero or more saved queries --> <element name="items" type="tns:QueryItem" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </complexType> <!-- This type represents a single saved query. --> <complexType name="QueryItem"> <sequence> <!-- The name of the query --> <element name="name" type="string" /> <!-- The display name associated with the query; this will contain the same value as the name --> <element name="displayName" type="string" /> <!-- The query's description --> <element name="description" type="string" /> <!-- The "kind" associated with the query; this will be set to "SAVED_SEARCH" --> <element name="kind" type="string" /> <!-- The id number associated with a saved search --> <element name="savedSearchID" type="long" nillable="true" /> <!-- The autorization type associated with the query; this will be set to "INSTANCE_BASED" --> <element name="authorizationType" 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" /> <!-- This field specifies the name of the attribute which serves as the key for the objects returned by this query. --> <element name="keyAttribute" type="string" /> <!-- not used --> <element name="locales" type="string" minOccurs="0" maxOccurs="unbounded" /> <!-- The pre-selected sort attributes for the query. --> <element name="sortAttributes" type="tns:SortAttribute" minOccurs="0" maxOccurs="unbounded" /> <!-- The pre-predefined size of items to be retrieved. --> <element name="size" type="integer" nillable="true" /> </sequence> </complexType> <!-- This type is used to return the set of attributes (data columns) that would be returned as the result of executing a particular saved query. --> <complexType name="QueryAttributes"> <complexContent> <extension base="pref:Data"> <sequence> <element name="identifier" type="string" /> <!-- The name of the query associated with this set of attributes --> <element name="query" type="string" /> <!-- The diplay name of the query; this is the same value as the name --> <element name="displayName" type="string" /> <!-- not used --> <element name="description" type="string" /> <!-- The "kind" associated with the query; this will be set to "SAVED_SEARCH" --> <element name="kind" type="string" /> <!-- The autorization type associated with the query. This will be set to one of: "INSTANCE_BASED", "ROLE_BASED" --> <element name="authorizationType" type="string" /> <!-- This field indicates the type of objects returned by this query. This will be one of "PROCESS_INSTANCE", "TASK", "TASK_TEMPL". --> <element name="entityTypeName" type="string" /> <!-- This field specifies the name of the attribute which serves as the key for the objects returned by this query. --> <element name="keyAttribute" type="string" /> <!-- not used --> <element name="locales" type="string" minOccurs="0" maxOccurs="unbounded" /> <!-- The pre-selected sort attributes for the query. --> <element name="sortAttributes" type="tns:SortAttribute" minOccurs="0" maxOccurs="unbounded" /> <!-- The pre-predefined size of items to be retrieved. --> <element name="size" type="integer" nillable="true" /> <!-- A list of zero or more attributes --> <element name="items" type="tns:QueryAttributeItem" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </complexType> <!-- This type describes a single attribute that would be returned as the result of executing a particular saved query. --> <complexType name="QueryAttributeItem"> <sequence> <!-- The attribute name --> <element name="name" type="string" /> <!-- A localized display name for the attribute --> <element name="displayName" type="string" /> <!-- not used --> <element name="description" type="string" /> <!-- The attribute's datatype --> <element name="type" type="string" /> <!-- not used; set to false --> <element name="isArray" type="boolean" /> <!-- The related query and attribute which provides this attributes' information --> <element name="sourceAttribute" type="string" /> <!-- A string that identifies attributes with a well-known value range --> <element name="content" type="string" /> <!-- The ID of the source attribute's table, as defined in the query table definition --> <element name="sourceQueryTableIdentifier" type="string" /> <!-- Specifies whether the attribute can be used as a sort attribute --> <element name="isSortable" type="boolean" minOccurs="0" maxOccurs="1" default="true" /> <!-- Specifies whether the attribute can be used as a filter attribute --> <element name="isFilterable" type="boolean" minOccurs="0" maxOccurs="1" default="true" /> </sequence> </complexType> <!-- This type is used to return the results of executing a particular saved query. --> <complexType name="QueryResultSet"> <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 list of attributes (columns) returned by this query --> <element name="attributeInfo" type="tns: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="cmn:Map" minOccurs="0" maxOccurs="unbounded" /> </sequence> </extension> </complexContent> </complexType> <!-- This type contains the information for a single attribute that is returned as the result of executing a saved query. --> <complexType name="AttributeInfo"> <sequence> <!-- The name of the attribute --> <element name="name" type="string" /> <!-- The datatype of the attribute --> <element name="type" type="string" /> <!-- A string that identifies attributes with a well-known value range --> <element name="content" type="string" /> <!-- not used; set to false --> <element name="isArray" type="boolean" /> <!-- The related query and attribute which provides this attributes' information --> <element name="sourceAttribute" type="string" /> <!-- The ID of the source attribute's table, as defined in the query table definition --> <element name="sourceQueryTableIdentifier" type="string" /> </sequence> </complexType> <!-- This type is used to return the number of rows (items) in the result set that would be returned by executing a particular saved query. --> <complexType name="QueryResultSetCount"> <complexContent> <extension base="pref:Data"> <sequence> <!-- The size of the result set (number of rows) --> <element name="count" type="integer" /> </sequence> </extension> </complexContent> </complexType> <!-- A container used to describe a sort attribute by its name and sort order. --> <complexType name="SortAttribute"> <sequence> <element name="name" type="string" /> <element name="sourceAttribute" type="string" /> <element name="sortOrder" type="string" /> <!-- ASC, DESC --> </sequence> </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:qry='http://rest.bpm.ibm.com/v1/data/query' xsi:type='qry:QueryResultSet'>
<identifier>TASK.TKIID</identifier>
<query>IBM.DEFAULTALLTASKSLIST_75</query>
<entityTypeName>TASK</entityTypeName>
<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>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>PI_DISPLAY_NAME</name>
<type>STRING</type>
<content>PROCESS_INSTANCE.DISPLAY_NAME</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.instanceName</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>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>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>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>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>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>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>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>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>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>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>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>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>TAD_DESCRIPTION</name>
<type>STRING</type>
<content>TASK_DESC.DESCRIPTION</content>
<isArray>false</isArray>
<sourceAttribute>IBM.DEFAULTALLTASKSLIST_75.taskNarrative</sourceAttribute>
<sourceQueryTableIdentifier>n/a</sourceQueryTableIdentifier>
</attributeInfo>
<items>
<item key='TASK.TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>53</value>
</item>
<item key='SNAPSHOT_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>1.0.1</value>
</item>
<item key='PROCESS_APP_ACRONYM'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>BPMRES1</value>
</item>
<item key='PI_PIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>53</value>
</item>
<item key='TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>53</value>
</item>
<item key='PI_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Employee Requisition for (53)</value>
</item>
<item key='TAD_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Task: Submit requisition</value>
</item>
<item key='SNAPSHOT_ID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</value>
</item>
<item key='PRIORITY'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:int'>30</value>
</item>
<item key='OWNER'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='KIND'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>KIND_PARTICIPATING</value>
</item>
<item key='ORIGINATOR'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
</item>
<item key='DUE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T04:20:12Z</value>
</item>
<item key='CONTAINMENT_CTX_ID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>53</value>
</item>
<item key='NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
</item>
<item key='STATE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>STATE_CLAIMED</value>
</item>
<item key='PT_PTID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>25.8403dd37-e049-46f5-8952-b7a46f0d198f</value>
</item>
<item key='PI_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Employee Requisition for (53)</value>
</item>
<item key='STATUS'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Received</value>
</item>
<item key='ACTIVATED'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T03:20:13Z</value>
</item>
<item key='TAD_DESCRIPTION'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Task: Submit requisition</value>
</item>
</items>
<items>
<item key='TASK.TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>54</value>
</item>
<item key='SNAPSHOT_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>1.0.1</value>
</item>
<item key='PROCESS_APP_ACRONYM'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>BPMRES1</value>
</item>
<item key='PI_PIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>54</value>
</item>
<item key='TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>54</value>
</item>
<item key='PI_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Employee Requisition for (54)</value>
</item>
<item key='TAD_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Task: Submit requisition</value>
</item>
<item key='SNAPSHOT_ID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2064.73dd1d1a-b533-46ef-ba79-c94cb3b0de87</value>
</item>
<item key='PRIORITY'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:int'>30</value>
</item>
<item key='OWNER'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='KIND'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>KIND_PARTICIPATING</value>
</item>
<item key='ORIGINATOR'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_admin</value>
</item>
<item key='DUE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T04:23:43Z</value>
</item>
<item key='CONTAINMENT_CTX_ID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>54</value>
</item>
<item key='NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit job requisition</value>
</item>
<item key='STATE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>STATE_CLAIMED</value>
</item>
<item key='PT_PTID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>25.8403dd37-e049-46f5-8952-b7a46f0d198f</value>
</item>
<item key='PI_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Employee Requisition for (54)</value>
</item>
<item key='STATUS'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Received</value>
</item>
<item key='ACTIVATED'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T03:23:43Z</value>
</item>
<item key='TAD_DESCRIPTION'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Task: Submit requisition</value>
</item>
</items>
<items>
<item key='TASK.TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>55</value>
</item>
<item key='SNAPSHOT_NAME' />
<item key='PROCESS_APP_ACRONYM' />
<item key='PI_PIID' />
<item key='TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>55</value>
</item>
<item key='PI_DISPLAY_NAME' />
<item key='TAD_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit Requisition</value>
</item>
<item key='SNAPSHOT_ID' />
<item key='PRIORITY'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:int'>30</value>
</item>
<item key='OWNER'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='KIND'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>KIND_ORIGINATING</value>
</item>
<item key='ORIGINATOR'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='DUE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-05-03T19:43:47Z</value>
</item>
<item key='CONTAINMENT_CTX_ID' />
<item key='NAME' />
<item key='STATE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>STATE_RUNNING</value>
</item>
<item key='PT_PTID' />
<item key='PI_NAME' />
<item key='STATUS'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>New</value>
</item>
<item key='ACTIVATED'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T19:43:47Z</value>
</item>
<item key='TAD_DESCRIPTION' />
</items>
<items>
<item key='TASK.TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>56</value>
</item>
<item key='SNAPSHOT_NAME' />
<item key='PROCESS_APP_ACRONYM' />
<item key='PI_PIID' />
<item key='TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>56</value>
</item>
<item key='PI_DISPLAY_NAME' />
<item key='TAD_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit Requisition</value>
</item>
<item key='SNAPSHOT_ID' />
<item key='PRIORITY'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:int'>30</value>
</item>
<item key='OWNER'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='KIND'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>KIND_ORIGINATING</value>
</item>
<item key='ORIGINATOR'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='DUE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-05-03T21:10:44Z</value>
</item>
<item key='CONTAINMENT_CTX_ID' />
<item key='NAME' />
<item key='STATE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>STATE_RUNNING</value>
</item>
<item key='PT_PTID' />
<item key='PI_NAME' />
<item key='STATUS'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>New</value>
</item>
<item key='ACTIVATED'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T21:10:44Z</value>
</item>
<item key='TAD_DESCRIPTION' />
</items>
<items>
<item key='TASK.TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>57</value>
</item>
<item key='SNAPSHOT_NAME' />
<item key='PROCESS_APP_ACRONYM' />
<item key='PI_PIID' />
<item key='TKIID'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>57</value>
</item>
<item key='PI_DISPLAY_NAME' />
<item key='TAD_DISPLAY_NAME'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>Submit Requisition</value>
</item>
<item key='SNAPSHOT_ID' />
<item key='PRIORITY'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:int'>30</value>
</item>
<item key='OWNER'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='KIND'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>KIND_ORIGINATING</value>
</item>
<item key='ORIGINATOR'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>tw_user</value>
</item>
<item key='DUE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-05-03T21:12:29Z</value>
</item>
<item key='CONTAINMENT_CTX_ID' />
<item key='NAME' />
<item key='STATE'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>STATE_RUNNING</value>
</item>
<item key='PT_PTID' />
<item key='PI_NAME' />
<item key='STATUS'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>New</value>
</item>
<item key='ACTIVATED'>
<value xmlns:ns5='http://www.w3.org/2001/XMLSchema' xsi:type='ns5:string'>2011-04-28T21:12:29Z</value>
</item>
<item key='TAD_DESCRIPTION' />
</items>
</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>
</sequence>
</complexType>
</schema>
| Code | Description |
|---|---|
| 200 OK | Successful completion - requested data returned. Note that the list might be empty.
|
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | The query 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. |
| Release | Description |
|---|---|
| 7.5.1 | A new parameter has been added to this method in order to allow additional filtering using a process application name.
|
7.5.0
Parent Topic: Task Instance Query Entity List Resource