Ping a TSO/E address space

You can use this operation to ping a TSO/E address space. Doing so at regular intervals helps to ensure that the TSO/E address space remains active for the client. Otherwise, the server can end the TSO/E address space without warning.

HTTP method and URI path

PUT /zosmf/tsoApp/tso/ping/<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.
  • ping informs the service to ping the specified TSO/E address space.
  • <servletKey> identifies the TSO/E address space for the service to ping.

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 each TSO/E address space has an idle application time that the TSO/E address space services interface uses to determine if the client application associated with the address space is active. If the idle application time is 10 minutes, the client application is considered to be inactive. In which case, the API ends all the TSO/E address spaces associated with the client application.

To prevent TSO/E address spaces from ending because of idle application time, callers can issue a ping request at least once every 5 minutes. Doing so informs the TSO/E address space services interface that the client application is still active, and causes the interface to reset the idle application time for all the TSO/E address spaces associated with the client application.

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 all the attributes in the JSON structure except the message data. For more details, see Content type used for HTTP request and response data.

Example

To ping the TSO/E address space identified by servlet key ZOSMFAD-71-aabcaaaf, submit the request depicted in Figure 1.
Figure 1. Sample request to ping a TSO/E address space
PUT /zosmf/tsoApp/ping/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 ping 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","timeout":false}
End of change
Parent topic: TSO/E address space services