To start a TSO/E address space on the z/OS.
Request line
POST https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/tso?proc=Procedure-name&chset=697&cpage=1047&rows=204&cols=160&rsize=Region-size&acct=Account-number
The variable part varies depending on the user environment. For details, see the IBM manual z/OS Management Facility Programming Guide.
Do not specify the following items in the EXEC PGM=IKJEFT01 statement of the logon procedure to be specified for proc=.
- PARM=ISPF
- PARM=PDF
- A PARM operand whose value is a CLIST member name that includes an ISPF or PDF startup command
The BCM Web API server cannot start while ISPF or PDF is running.
Request body
None
Response body
{"servletKey":"servletKey","queueID":"queueID", "sessionID":"sessionID","ver":"vvrr", "tsoData": [ {"TSO MESSAGE": {"VERSION":"0100", "DATA":"IKJ56455I userID LOGON IN PROGRESS AT 00:00:00 ON APRIL 1,2022"}}, {"TSO MESSAGE":{"VERSION":"0100","DATA":"IKJ56951I NO BROADCAST MESSAGES"}}, {"TSO MESSAGE":{"VERSION":"0100","DATA":"READY"}}, {"TSO PROMPT":{"VERSION":"0100","HIDDEN":"FALSE"}}], "reused":false,"timeout":false}
Key |
Format |
Description |
---|---|---|
servletKey |
string |
The ID of the TSO/E address space. Specify this in the request line of the BCM Web API request. |
queueID |
string |
The ID of the z/OS UNIX message queue. Specify this in the request body of the BCM Web API request for starting the BCM Web API server. |
ver |
string |
The version of the REST API for z/OSMF TSO/E address space services |
tsoData |
object |
TSO/E messages object# If the IKJ56455I message is not output here or the response message does not include the tsoData key, the TSO/E address space might not have started correctly. In such case, review the values for procedure-name, region-size, and account-number in the request line, as well as the logon procedure, z/OSMF settings, and other information. If the response message includes a TSO/E message or a z/OSMF message, follow the instructions in that message. |
reused |
boolean |
Reconnected indicator For details, see the IBM manual z/OS Management Facility Programming Guide. |
timeout |
boolean |
|
# Depending on the timing, the IKJ5695I message and subsequent messages might not be output after the IKJ56455I message. In such cases, to unify the subsequent BCM Web API requests and responses, before starting the BCM Web API server, get the IKJ56951I message and READY message by running the following API request for getting TSO/E messages.
Request line
GET https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/tso/servletKey
Request body
None
If an address space remains idle for 15 minutes after it starts, it will end. In such cases, restart the TSO/E address space.