This API lets obtain a chunk of a list of PAC object - status links.
APINOSLS can be invoked with:
CALLNAT 'APINOSLS' API-PARM API-OSLS-PARM
To obtain a chunk set API-PARM.API-MAIN-FUNC at 'S'. Set API-PARM.API-SUB-FUNC at ' ', if only current links are wanted; set it at 'H', if historical links too should participate in the selection.
This document covers the following topics:
A definition of API-OSLS-PARM is provided in LDA UPILOSLS.
| Field Name | Format | Description | |
|---|---|---|---|
| API-OSLS-PARM | |||
| OBJECT | A33 | in | |
| TYPE1 | A1 | in | |
| TYPE2 | A16 | in | |
| VERSION-FM | N5 | in | |
| VERSION-TO | N5 | in | |
| APPLICATION | A33 | in | |
| APPLICATION-TYPE | A16 | in | |
| STATUS | A33 | in | |
| STATUS-TYPE | A16 | in | |
| EVENT | A33 | in/out | |
| ADD-TIME-FM | T | in | |
| ADD-TIME-TO | T | in | |
| ADD-BY | A9 | in | |
| ADD-TID | A9 | in | |
| SUP-TIME-FM | T | in | |
| SUP-TIME-TO | T | in | |
| LINE-CNT | N3 | out | |
| LINE-TOT | N10 | in/out | |
| LINE | A250 (1:60) 1* | out | |
| LINE-STRC | (1:60) | ||
| LINE-NR | B2 | ||
| LINE-OBJECT | A32 | ||
| LINE-TYPE1 | A1 | ||
| LINE-TYPE2 | A4 | ||
| LINE-VERSION | N5 | ||
| LINE-APPLICATION | A32 | ||
| LINE-APPLICATION-TYPE | A1 | ||
| LINE-STATUS | A32 | ||
| LINE-STATUS-TYPE | A1 | ||
| LINE-EVENT | A32 | ||
| LINE-ADD-TIME | T | ||
| LINE-ADD-BY | A8 | ||
| LINE-ADD-TID | A8 | ||
| LINE-SUP-TIME | T | ||
| LINE-PAD | A78 | ||
| API-PAC-AREA | A160 | in/out | |
1*: This is the proposed default value. Any value equal or greater 1 can be defined by the user.
[API-OSLS-PARM.OBJECT] should carry a specification of a range that the object names of the links to be selected must fit into.
[API-OSLS-PARM.TYPE1] should be:
| ' ' | if the selection is not to be restricted to links of objects of one type1, |
| D | if only links of DDMs are wanted, |
| E | if only links of error messages are wanted, |
| F | if only links of foreign objects are wanted, |
| N | if only links of NATURAL objects are wanted. |
If [API-OSLS-PARM.TYPE1] = 'F', then API-OSLS-PARM.TYPF2 may carry the PAC foreign type code of the objects whose links are to be selected. It should be the "3-less" code; eg, 'JCL' rather than '3JCL'.
If [API-OSLS-PARM.TYPE1] = 'N', then API-OSLS-PARM.TYPE2 may carry a sequence of one character external codes of NATURAL types (eg, 'N' for subprogram or 'P' for program).
API-OSLS-PARM.VERSION-FM and API-OSLS-PARM.VERSION-TO may carry the specification of an interval for the PAC version numbers of the objects whose links are to be selected. [API-OSLS-PARM.VERSION-TO] = 0 does not impose an upper bound on the PAC version numbers.
API-OSLS-PARM.APPLICATION may carry a range of names specifying the PAC (ACF) compartments whose objects' links are to participate in the selection.
PI-OSLS-PARM.APPLICATION-TYPE may carry a sequence of one character PAC compartment type codes.
The codes are:
| D | for type PREDICT, |
| N | for type NATURAL, |
| P | or application PREDICT-CASE. |
The field should be left blank if links of objects from compartments of various types are to participate in the selection.
API-OSLS-PARM.STATUS may carry a spacification of a range that the status names of the links to be selected must fit into.
API-OSLS-PARM.STATUS-TYPE may carry a sequence of one character PAC status type codes. The codes of types of statuses for which there can be object - status links are:
| A | for ARCHIVE, |
| M | for maintenance, |
| P | for production, |
| T | for test. |
The field should be left blank if links of statuses of various types are to participate in the selection.
API-OSLS-PARM.EVENT may carry a range of names specifying the migration events which must have created the links to be selected.
An interval for the creation times of the links to be selected may be specified in API-OSLS-PARM.ADD-TIME-FM and API-OSLS-PARM.ADD-TIME-TO. Values achieved by resetting do not impose bounds on the times of the links being selected.
API-OSLS-PARM.ADD-BY may carry a range of names specifying the ids of the users who must have had submitted the migration events which have created the links to be selected.
API-OSLS-PARM.ADD-TID may carry a range of names specifying the ids of the terminals from which the migration events which have created the links to be selected must have been submitted.
An interval for the superseding times of the links to be selected may be specified in API-OSLS-PARM.SUP-TIME-FM and API-OSLS-PARM.SUP-TIME-TO. Values achieved by resetting do not impose bounds on the times of the links being selected.
[API-OSLS-PARM.LINE-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the number of lines (the size of the chunk) to be returned. In particular, no lines will be returned, if LINE-CNT EQ 0. APINOSLS returns in API-OSLS-PARM.LINE-CNT the number of lines of the returned chunk. It may be less than the adjusted original value, if the end of the list has been reached.
Normally, API-OSLS-PARM.LINE-TOT should be reset when the first chunk of a list is wanted and left untouched until the processing of the list is finished. It will then after each call carry the total of list entries already returned.
API-OSLS-PARM.LINE will carry the returned chunk.
Normally, API-OSLS-PARM.API-PAC-AREA should be reset when the first chunk of a list is wanted. API-OSLS-PARM.API-PAC-AREA should be left untouched for a next call to obtain an immediately following chunk of the list.
APINOSLS returns the following [API-PARM.API-MSG-NO]:
| 0000 | if a non-final chunk of a list is being returned. |
| 0070 | if no links satisfying the selection criteria have been found. |
| 1011 | if the specified [API-PARM.API-MAIN-FUNC] or [API-PARM.API-SUB-FUNC] is meaningless. |
| 9999 | if at least one link satisfying the selection criteria has been found and a final chunk of a list is being returned. |
Other values of API-PARM.API-MSG-NO may be received in more unusual situations.