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 Template List Resource - GET Method

Use this method to retrieve a list of task templates that match specified filter criteria.

Resource URI

GET /v1/taskTemplates/filter?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
whereClause string
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.
size integer
The maximum number of list entries to be returned.

Request Content

None.

Response Content

List of task templates.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "HTM Task Template List", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"}, 
      "items": 
      [
         {  "applicationDefaultsID": {"type": "string",
               "description": "ID of the application component that specifies the defaults for tasks derived from this template."
            },
            "applicationName": {"type": "string",
               "description": "Name of the application the task template is part of."
            },
            "autoDeletionMode": {"type": "string",
               "description": "States whether an instance derived from the task template is automatically or conditionally deleted when it reaches an end execution state."
            },
            "autonomy": {"type": "string",
               "description": "States for standalone tasks whether an instance of the task template runs dependently of a potential parent or not.",
               "enum":
               [
                  "AUTONOMY_CHILD",
                  "AUTONOMY_PEER",
                  "AUTONOMY_NOT_APPLICABLE"
               ]
            },
            "calendarName": {"type": "string",
               "description": "Name of the calendar used, for example, for expiration calculations."
            },
            "clientTypes": {"type": ["string"],
               "description": ""
            },
            "containmentContextID": {"type": "string",
               "description": "ID of the context the task template belongs to."
            },
            "contextAuthorizationOfOwner": {"type": "string",
               "description": "Authorization rights of owners of tasks that are derived from this template to the associated context."
            },
            "customProperties": {"type": "object", "additionalProperties": {"type": "string"},
               "description": "List of cutom property names and values."
            },
            "definitionName": {"type": "string",
               "description": "Name of the task template definition in the TEL."
            },
            "definitionNamespace": {"type": "string",
               "description": "XML Schema namespace of the task template definition in the TEL."
            },
            "description": {"type": "string",
               "description": "Description of the task template."
            },
            "displayName": {"type": "string",
               "description": "Display name of the task template."
            },
            "durationUntilDeleted": {"type": "string",
               "description": "Duration that task instances derived from this template are kept after they have reached an end state."
            },
            "durationUntilDue": {"type": "string",
               "description": "Duration when tasks derived from this template become due."
            },
            "durationUntilExpires": {"type": "string",
               "description": "Duration when tasks derived from this template expire once they are activated."
            },
            "eventHandlerName": {"type": "string",
               "description": "Name of the associated event handler."
            },
            "isAdHoc": {"type": "boolean",
               "description": "States whether the task template has been created ad-hoc."
            },
            "isBusinessRelevant": {"type": "boolean",
               "description": "States whether a task derived from this template is a business relevant or an 'auxiliary' step."
            },
            "isInline": {"type": "boolean",
               "description": "States whether the task template describes an inline task or not."
            },
            "jndiNameOfCalendar": {"type": "string",
               "description": "JNDI name of a user-defined calendar."
            },
            "jndiNameOfStaffPluginProvider": {"type": "string",
               "description": "JNDI name of a user-defined people directory configuration."
            },
            "kind": {"type": "string",
               "description": "Kind of tasks derived from this template."
            },
            "name": {"type": "string",
               "description": "Name of the task template."
            },
            "namespace": {"type": "string",
               "description": "Namespace that categorizes the task template."
            },
            "priority": {"type": "integer",
               "description": "Priority of tasks derived from this template."
            },
            "priorityDefinition": {"type": "string",
               "description": "Priority definition for tasks derived from this template."
            },
            "state": {"type": "string",
               "description": "States whether the task template is started or stopped."
            },
            "substitutionPolicy": {"type": "string",
               "description": "Substitution policy that takes place when people assignments are performed for tasks derived from this task template."
            },
            "supportsAutomaticClaim": {"type": "boolean",
               "description": "States whether a task derived from this template is claimed automatically when it becomes ready."
            },
            "supportsClaimIfSuspended": {"type": "boolean",
               "description": "States whether tasks derived from this template can be claimed even if they are suspended."
            },
            "supportsDelegation": {"type": "boolean",
               "description": "States whether tasks derived from this template support delegation, for example, by transferring work items."
            },
            "supportsFollowOnTasks": {"type": "boolean",
               "description": "States whether tasks derived from this template support the creation of follow-on tasks."
            },
            "supportsSubTasks": {"type": "boolean",
               "description": "States whether tasks derived from this template support the creation of subtasks."
            },
            "tktid": {"type": "string",
               "description": "Task template ID."
            },
            "type": {"type": "string",
               "description": "Type of the task template."
            },
            "validFromTime": {"type": "string", "format": "date-time",
               "description": "Time the task template became or becomes valid."
            }
         }
      ]
   }
} 

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
The returned human task template objects contain a new property:
  • "autonomy"

Available Since

6.1.2

Parent Topic: Task Template List Resource