Receive messages from a TSO/E address space

You can use this operation to receive messages from a TSO/E address space.

HTTP method and URI path

GET /zosmf/tsoApp/tso/<servletKey>

where:

zosmf/tsoApp identifies the TSO/E address space services.
tso informs the service that the request is for a TSO/E address space.
<servletKey> identifies the TSO/E address space from which to receive messages.

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.

In addition, note that the API will attempt to read TSO/E messages. If no TSO/E messages are received after 15 seconds, a timeout indication will be returned.

Required authorizations

See Required authorizations.

Expected response

On completion, the service 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. For more details, see Error handling.

The response also includes a JSON object that contains the TSO/E response messages, or a timeout indication. For more details, see Content type used for HTTP request and response data.

Example

To read TSO/E messages from the TSO/E address space identified by servlet key ZOSMFAD-71-aabcaaaf, submit the request depicted in Figure 1.

Figure 1. Sample request to receive a message from a TSO/E address space

GET /zosmf/tsoApp/tso/ZOSMFAD-71-aabcaaaf HTTP/1.1
Host: zosmf1.yourco.com

A sample response is shown in Figure 2. Start of change

Figure 2. Sample response from receive message from a TSO/E address space request

HTTP/1.1 200 OK
Date: Thu, 13 Jan 2011 05:39:28 +0000GMT
Connection: close

{"servletKey":"ZOSMFAD-71-aabcaaaf","ver":"0100","tsoData":
[{"TSO MESSAGE":{"VERSION":"0100","DATA":"--> LOGON proc version = 04/28/2011"}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"  "}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"--> System Name   = DCEIMGNE"}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"--> System Suffix = NE"}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"--> SYSPLEX Name  = CFCIMGNE"}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"--> SYSRES Volume = SD1131"}},
{"TSO MESSAGE":{"VERSION":"0100","DATA":"  "}}],
"timeout":false}