APINSELO

#### Search Results

Search

# APINSELO

This API lets the user obtain chunks of lists of current and historical object status links.

APINSELO can be invoked with:

    CALLNAT 'APINSELO' API-PARM API-OBJECT-STATUS API-PAC-AREA

The API allows both MAIN-FUNCTION parameters as well as SUB-FUNCTION parameters.

MAIN-FUNCTION parameter:

N | get a list of objects not assigned to a status
O | obtain a chunk of a list of objects belonging to a given application and migrated to a given test, production, or maintenance deployment
S | obtain a chunk of a list of object status links for any, or one given, application and any status.

SUB-FUNCTION parameters:

H | get a list of both the current and the historical object status links satisfying the selection criteria
blank | get a list of only the current object status links satisfying the selection criteria

This document covers the following topics:

- Local Data Area UGNASELO

- API Return Codes

## Local Data Area UGNASELO

A definition of API-OBJECT-STATUS is provided in PDA .

Field Name | Format | I/O
--- | --- | ---
API-OBJECT-STATUS |  |
API-APPLICATION | A32 | in
API-STATUS | A32 | in
API-SEL-OBJECT | A32 | in
API-OBJECT-LIST | A32 (10) 1* | out
API-OBJVER-LIST | N5 (10) 1* | out
API-OBJTYP-LIST | A6 (10) 1* | out
API-APPLICATION-LIST | A32 (10) 1* | out
API-STATUS-LIST | A32 (10) 1* | out
API-TIME-IN-LIST | T (10) 1* | out
API-TIME-OU-LIST | T (10) 1* | out
API-COUNT | N2 | out
API-PAC-AREA | B126 | out

1*: This is the proposed default value. Any value equal or greater 1 can be defined by the user.

When APINSELO is called:

- API-OBJECT-STATUS.API-SEL-OBJECT should carry an object name specification. '*', '<', or '>' may be used.

- A single application must be specified in API-OBJECT-STATUS.API-APPLICATION if [API-PARM.API-MAIN-FUNC] = 'O'.

- A single application may be specified in API-OBJECT-STATUS.API-APPLICATION if [API-PARM.API-MAIN-FUNC] = 'S'.

  Please note that inter-application searches may take very long.

- A single status must be specified in API-OBJECT-STATUS.API-STATUS if [API-PARM.API-MAIN-FUNC] = 'O'; the field's value is ignored if [API-PARM.API-MAIN-FUNC] = 'S'.

- Normally, API-OBJECT-STATUS.API-PAC-AREA should be reset when the first chunk of a list is required and left untouched for a next call to obtain the following chunk of the same list.

- To select objects that have no status, set [API-PARM.API-MAIN-FUNC] = 'N' and [API-PARM.API-SUB-FUNC] = blank. This will produce a list of objects that have no status.

APINSELO returns in API-OBJECT-STATUS.API-COUNT the number of object status links in the returned chunk.

The [API-OBJECT-STATUS.API-TIME-IN-LIST] of a link is the time of the versioned object's emigration to the deployment.

The [API-OBJECT-STATUS.API-TIME-OU-LIST] of a link is the time at which a PAC migration was run to remove the object from, or supersede it in, the deployment. This value is non-null only if the link is historical.

## API Return Codes

APINSELO returns the following [API-PARM.API-MSG-NO]:

0000 | if object - status links satisfying the selection criteria have been found and a chunk of their list is being returned,
1011 | if the specified ([API-PARM.API-MAIN-FUNC],[API-PARM.API-SUB-FUNC]) is meaningless,
7325 | if no object - status links have been found to satisfy the selection criteria,
9999 | only if object status links satisfying the selection criteria have been found and the final chunk of their list is being returned.

Other values of API-PARM.API-MSG-NO may be received in more unusual situations.

### On this page

- Local Data Area UGNASELO
- API Return Codes