Obtain a list of all tasks that are eligible to be handlers
The handlerEligible property indicates whether a z/OSMF task can participate in the application linking process as an event handler. To obtain a list of the tasks with the handlerEligible property set to true, use the GET method.
HTTP method and URI path
GET /zosmf/izual/rest/adm/getHandlerEligibleTasks?eventTypeId=<eventTypeId>where:
- /zosmf/izual/rest/adm identifies the Application Linking Manager interface.
- getHandlerEligibleTasks indicates that the service will retrieve a list of tasks that are eligible to be event handlers.
- eventTypeId=<eventTypeId> is the event type for which the request is being submitted.
Standard headers
Use the following standard
HTTP header with this request:
Content-Type: application/json
Custom headers
None.
Request content
None.
Usage considerations
Required authorizations
Expected response
On completion, the Application Linking Manager interface returns an HTTP response, which includes a status code indicating whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error has occurred. See Error handling.
The
response also includes a JSON object with additional information about
the results of the request. If your request is successful, the JSON
object contains null data for the error field, and the result field
lists the task ID, navigation URL, display name, and plug-in ID for
each task that is eligible to be a handler. Figure 1 provides
a sample response for a successful request.
Figure 1. Sample response from a successful list tasks request
HTTP/1.1 200 OK
Date: Thu, 13 Jan 2011 05:39:28 +0000GMT
Connection: close
{"error":null,"result":{"Task":[
{"TaskID":"test2","navigationUrl":"\/zosmf\/test2","displayName":"test2","PluginID":"TestPlugin1"},
{"TaskID":"test3","navigationUrl":"\/zosmf\/test3","displayName":"test3","PluginID":"TestPlugin1"},
{"TaskID":"test4","navigationUrl":"\/zosmf\/test4","displayName":"test4","PluginID":"TestPlugin1"},
{"TaskID":"test1","navigationUrl":"\/zosmf\/test1","displayName":"Test1","PluginID":"TestPlugin2"}
]}}For an unsuccessful request, the JSON object contains an error message in the error fields, msgid and msgtext.