Obtain a list of handlers for an event type

You can use this operation to obtain a list of registered handlers for an event type.

HTTP method and URI path

GET /zosmf/izual/rest/handler?eventTypeId=<eventTypeId>

where:

/zosmf/izual/rest identifies the Application Linking Manager interface.
handler identifies the event handler component of the application linking process.
eventTypeId=<eventTypeId> is the ID of the event type for which you want to obtain a list of registered handlers.

Standard headers

Use the following standard HTTP header with this request:

Content-Type: application/json

Custom headers

None.

Request content

None.

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

See 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, as shown in Figure 1, Figure 2, and Figure 3.

If the request is successful and one or more handlers are enabled for the event type, information about the registered handlers are returned, as depicted in Figure 1.

Figure 1. Example: Handlers enabled for the event type

{"result":[{"id":"IBM.ZOSMF.IZU_IMPORT_HANDLER","taskId":"IZUG_TASK_zOSMFImportManager",
"enabled":true,"defaultHandler":false,"applId":"IzuImportManager","type":"INTERNAL",
"displayName":"Import Manager","url":"\/zosmf\/IzuImportUtility\/index.jsp",
"eventTypeId":"IBM.ZOSMF.IMPORT_EXTERNAL_APP",
"options":{"CONTEXT_SUPPORT":"OPT_CONTEXT_SUPPORT_LAUNCH_AND_SWITCH"}}],"error":null}

If the request is successful and no handlers are registered for the event type, the result field contains null data, as depicted in Figure 2.

Figure 2. Example: Returned results of a successful list handlers request

{"result":null,"error":null}

If the request is successful and all the handlers that are registered for the event type are disabled, the result field contains an empty array, as depicted in Figure 3.

Figure 3. Example: Returned results of a successful list handlers request

//Result if all the handlers defined for the event type are disabled.
{"result":[], "error":null}

For an unsuccessful request, the JSON object contains an error message in the error fields, msgid and msgtext.