REST Interface for BPEL-related Task Resources - Task Instance Query Entity List Resource - GET Method

Sample method invocation

Parameters

Optional Parameters

Name	Value Type	Description
selectedAttributes	string	Comma-separated list of attributes, in uppercase letters, which specifies the attributes that are retrieved by the query. If no selected attributes are specified, all the attributes that are defined on the query table are returned.
interactionFilter	string	Name of a predefined user interaction. Value Description WORK_ON Work on tasks. This implies the retrieval of to-do and collaboration tasks which are already claimed by the current user. This value requires that a query table is used where TASK is the primary query table and TASK.KIND and TASK.STATE are provided as source attributes. For query tables that include TASK.SUSPENDED as source attribute, the filter value excludes tasks that are suspended. In effect, the filter value retrieves claimed tasks that are not supended. WORK_ON_ACTIVE Work on tasks. Similar to the behavior for the filter value WORK_ON with the addition, that for query tables including TASK.IS_WAIT_FOR_SUB_TK as source attribute, the filter value excludes tasks that are waiting for sub-tasks. ASSESS_AVAILABLE Assess available tasks. This implies the retrieval of to-do and collaboration tasks which can be claimed by the current user. This value requires that a query table is used where TASK is the primary query table and TASK.KIND and TASK.STATE are provided as source attributes. For query tables including TASK.SUPPORT_CLAIM_SUSP and TASK.SUSPENDED as source attributes, the filter value excludes tasks that are suspended. In effect, the filter value retrieves tasks that can be claimed and are not supended. ASSESS_AND_WORK_ON Assess and work on tasks. This implies the retrieval of tasks as implied by the WORK_ON or the ASSESS_AVAILABLE filter values. Equivalent conditions apply with respect to source attributes. BACKLOG Resume backlog. This implies the retrieval of to-do and collaboration tasks which are suspended and for which the current user is either the owner, originator or an administrator. This value requires that a query table is used where TASK is the primary query table and TASK.KIND and TASK.STATE are provided as source attributes. CHECK_STATUS Check status of tasks created or started by the user. This implies the retrieval of collaboration and invocation tasks for which the current user is either the starter, originator or potential starter. This value requires that a query table is used where TASK is the primary query table and TASK.KIND and TASK.STATE are provided as source attributes. Moreover, if TASK.INVOKED_INSTANCE_ID is provided by the query table then invocation tasks are excluded, which are instantiated by a process. MANAGE Manage tasks. This implies the retrieval of to-do, collaboration and invocation tasks for which the current user is an administrator. This value requires that a query table is used where TASK is the primary query table and TASK.KIND is provided as source attribute. BROWSE_ALL Browse all tasks. This implies the retrieval of to-do, collaboration and invocation tasks for which the current user is an administrator, the owner, the originator, a potential owner, the starter, a potential starter or a reader. This value requires that a query table is used where TASK is the primary query table and TASK.KIND is provided as source attribute.
queryFilter	string	A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query table can be referenced. Constants are available for some attributes of predefined query tables, for example, STATE_RUNNING (for available constants, see [BPC DB Views]). If instance-based authorization is required, columns that are defined on the WORK_ITEM query table can be also referenced using the prefix 'WI.', for example, WI.REASON=REASON_POTENTIAL_OWNER.
processAppName	string	Name of the process application, which is used for additional filtering.
sortAttributes	string	Comma-separated list of sort criteria applied to the list of returned task instance entities. Each list entry is in the form attribute [ASC|DESC] where ascending is the default.
offset	integer	Specifies the number of entities to be skipped in the result set.
size	integer	Limits the number of entities returned. The threshold setting might not be accurate.
everybody	boolean	Authorization option specifying that everybody work items (which is the staff verb "Everybody") are taken into account if instance-based authorization is enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
individual	boolean	Authorization option specifying that individual work items, for example, the staff verb "Users", are considered if enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
group	boolean	Authorization option specifying that group work items, for example, the staff verb "Group", are taken into account if instance-based authorization is enabled on the query table and if enabled on the Human Task Container. This parameter has no default. If it is omitted then the settings of the query table definition apply.
inherited	boolean	Authorization option specifying that inherited work items are considered, for instance, the administrator of a process instance might then see participating human task instances created for that process instance if it executes a query against that query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
admin	boolean	Administration authorization option specifying whether the request is performed by an administrator. Value Description true The request is performed by an administrator. The user must have administrative rights to perform this request. If the onBehalfUser parameter is specified as well then the request is performed as if the specified user had sent the request, otherwise, the request runs as administrator. false (default) The request is performed by a regular user who doesn't have administrative rights.
onBehalfUser	string	Administration authorization option specifying that the query is run under the authority of the specified user, and the objects in the query table are checked against the work items for this user if instance-based authorization is used. This parameter is only valid if the admin parameter has been specified with a value true. If admin is set true and this parameter is not used then the request runs as administrator.

Request Content

None

Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "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",
               "description": "The ID of the source attribute's table, as defined in the query table definition."
            }
         }
      ],
      "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)."
         }
      ]
   }
}

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "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."
      }
   }
} 

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. The requested data is 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.

Change history

The following changes have been applied to this method:

Release	Description
7.5.1	A new parameter has been added to this method to allow additional filtering using a process application name. "processAppName"

Available since

7.5

Parent topic: Task Instance Query Entity List Resource