Using the Application Programming Interface › Data Returned from the API

Data Returned from the API

After you send a command to the API, the data from the display is returned up to the limit specified by the LIMIT keyword. The data is returned in the external data queue or stack.

The following types of lines are returned when a command is executed:

Message

The first position of a message line contains the letter M. This line is always first and is always present even if there is no message. The message text starts in the second position of the line. Only one message line is returned for each call to the API.

Title

The first position of a title line contains the letter T. The following fields are returned in this order:

• Product name
• Product release
• System ID where the information is obtained
• Command that produces the information
• Current date
• Current time

The second position of the title line contains a default delimiter that marks the start of each field. Specify the default delimiter with the DELIMITER keyword. Only one title line is returned for each call to the API.

Info

The first position of an information line contains the letter I. They contain the information line fields from the command display. Multiple information lines can be returned depending on the number of information lines on the command display.

Header

The first position of a header line contains the letter H. The header line contains the header line fields from the command display. If the second position of the line contains the default delimiter, the delimiter marks the start of each field. If the second position is blank, the fields are not delimited.

Data

The first position of a data line contains the letter D. They contain the data line fields from the command display. If the second position of the line contains the default delimiter, the delimiter marks the start of each field. If the second position is blank, the fields are not delimited. Multiple data lines can be returned.