WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Human Task Manager REST Interface - Task Instance List Resource - GET Method

Use this method to retrieve a list of human task instances.

Resource URI

GET /v1/tasks/filter?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
whereClause string
Specifies the filter criteria applied when the query is executed.
orderByClause string
Orders the result of the query execution by the values of the columns you identify.
offset integer
Return results after the specified list entry.
size integer
The maximum number of list entries to be returned.

Request Content

None.

Response Content

List of human tasks.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task List", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "items": 
      [
         {  "activationTime": {"type": "string","format": "date-time",
               "description": "Time the task instance is set into the ready state - this also happens when the task is restarted or when a claim is canceled."
            },
            "description": {"type": "string",
               "description": "Description of the task."
            },
            "displayName": {"type": "string",
               "description": "Display name of the task."
            },
            "dueTime": {"type": "string", "format": "date-time",
               "description": "Time when the task is due."
            },
            "durationUntilExpires": {"type": "string",
               "description": "Duration when the task expires once it is activated."
            },
            "firstActivationTime": {"type": "string","format": "date-time",
               "description": "Time the task instance is set into the ready state for the first time."
            },
            "isWaitingForSubTask": {"type": "boolean",
               "description": "States whether the task is waiting for the completion of a subtask."
            },
            "kind": {"type": "string",
               "description": "Kind of the task."
            },
            "name": {"type": "string",
               "description": "Name of the task instance."
            },
            "originator": {"type": "string",
               "description": "ID of the user that created the task instance or on whose behalf the task instance was created."
            },
            "owner": {"type": "string",
               "description": "Owner of the task instance."
            },
            "positionInHierarchy": {"type": "string", 
               "description": "Position in a possible task instance hierarchy.",
               "enum":
               [
                  "HIERARCHY_POSITION_FOLLOW_ON_TASK",
                  "HIERARCHY_POSITION_SUB_TASK",
                  "HIERARCHY_POSITION_TOP_TASK"
               ]
            },
            "priority": {"type": "integer",
               "description": "Priority of the task instance."
            },
            "starter": {"type": "string",
               "description": "Starter of the task instance."
            },
            "startTime": {"type": "string", "format": "date-time",
               "description": "Time when the task was claimed or when an invocation task enters the running state."
            },
            "state": {"type": "string",
               "description": "State of the task instance."
            },
            "taskTemplateID": {"type": "string",
               "description": "ID of the task template this instance is derived from."
            },
            "tkiid": {"type": "string",
               "description": "Task instance ID."
            },
            "type": {"type": "string",
               "description": "Type of the task."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text 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:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
400 Bad RequestThe parameters are not valid or they are missing.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Change History

The following changes have been applied to this method:
ReleaseDescription
6.2
Each array element in the returned list of human tasks contains new properties:
  • "isWaitingForSubTask"
  • "positionInHierarchy"
6.2.0.1
Each array element in the returned list of human tasks contains new properties:
  • "activationTime"
  • "firstActivationTime"

Available Since

6.1.2

Parent Topic: Task Instance List Resource