LIST – Find objects in the Database and Plans

Use the LIST request to retrieve a list of records of a selected type.

LIST <resource> <arguments> VALID(<date>) SAVELIST(<listname>)

When you use LIST, the resulting list includes only the common segments of the records. By default, no other segments is retrieved and Batch Loader statements are not generated. To do this, you must SELECT a record by adding the keyword SELECT(Y) to the LIST statements. To make this the default behaviour, specify OPTIONS SELECT(Y) for all LIST statements. For more details, see Automatic SELECT and DELETE.

For retrieving current plan occurrences and operations, the default is to retrieve all matching objects except those in deleted status. When you specify the argument STATUS, it overrides the default processing.

Argument names specify field names of the record to be tested to determine if the record should be included in the list.

Note:
  1. Because the first blank or comparison-operator symbol ends the argument value, you cannot search for fields that contain imbedded blanks or comparison-operator symbols.
  2. The wildcard search arguments asterisk (*) and percent sign (%), cannot be used in the year part (YY) of date arguments.
  3. To use a comparison operator (such as <, >, or ≠) in an argument that contains an IA value including a date and time, specify the complete value as the argument. The comparison operator can follow this value.
  4. The values of PIF arguments as dates depend on the PIF base year, which is defined by the PIFCWB keyword on the INTFOPTS statement, or the CWBASE keyword of the INIT statement. The value of the VALTO argument for default high date depends on the PIFHD keyword of the INTFOPTS statement or the HIGHDATE keyword of the INIT statement.
  5. The HCL Workload Automation for Z programming interface requires that you use the Common Segment in LIST requests. WAPL allows the record to be specified instead, and translates this internally to the common segment before passing the request to the PIF.
The return codes are:
0
The request was successful.
4
The request was not successful, for one of the following reasons:
  1. The requestor is not authorized to read the records.
  2. No records meet the criteria specified by the arguments.
8
The request was not successful. An error message is issued to the message log data set.