JSON format for TSO/E messages

TSO/E messages are written to the z/OS® UNIX message queue using message type identifiers 2 and 32770 and are formatted as follows:

{“message-type”:{“VERSION”:“JSON-version",“data-type”:“data-value”}}

where:

message-type

Keyword that identifies the type of TSO/E message. Table 1 lists and describes the message types that can be used for message type identifiers 2 and 32770.

Table 1. Message types
Message Type	Description	Message Type ID
TSO MESSAGE	Indicates that the system has created data or a message to be displayed on the client. The caller should read the message and display it accordingly.	2
TSO PROMPT	Indicates that the system requires a response from the client.	2
TSO RESPONSE	Indicates that a response was created by the client in response to a prompt. Callers should use this keyword when writing a response to the message queue.	32770

JSON-version

A four-digit number that identifies the JSON version used to format the message.

data-type

Keyword that describes the type of data included in the data-value variable. Table 2 lists and describes the data types that can be used for each TSO/E message type.

Table 2. Data types
Data Type	Description	Message Type
DATA	Indicates that the data included in the `data-value` variable is either a message from the system or a response from the client. For this data type, the `data-value` variable is a character string that can contain up to 32,767 bytes.	TSO MESSAGE and TSO RESPONSE
HIDDEN	Indicates whether the client should hide or mask the response. For this data type, the `data-value` variable is a Boolean that can have the value of either TRUE or FALSE. When TRUE, this tells the client to hide or mask the response as it is entered. Otherwise, the response will display as it is entered.	TSO PROMPT
ACTION	Indicates that the caller would like to interrupt or end a process that is in progress. For this data type, specify ATTN as the value for the `data-value` variable. Callers should use the CEATsoRequest API to issue the CeaTsoAttn request type before using a message to issue an attention interrupt. Use this data type only if the CeaTsoAttn request fails.	TSO RESPONSE