Endevor® for OS/390

API Guide
3.9
This documentation and related computer software program (hereinafter referred to as the “Documentation”) is for
the end user's informational purposes only and is subject to change or withdrawal by Computer Associates Interna-
tional, Inc. (“CA”) at any time.

THIS DOCUMENTATION MAY NOT BE COPIED, TRANSFERRED, REPRODUCED, DISCLOSED, OR

DUPLICATED, IN WHOLE OR IN PART, WITHOUT THE PRIOR WRITTEN CONSENT OF CA. THIS DOC-
UMENTATION IS PROPRIETARY INFORMATION OF CA AND PROTECTED BY THE COPYRIGHT LAWS
OF THE UNITED STATES AND INTERNATIONAL TREATIES.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS”
WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRAN-
TIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN
NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT
LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS
EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.

THE USE OF ANY PRODUCT REFERENCED IN THIS DOCUMENTATION AND THIS DOCUMENTATION
IS GOVERNED BY THE END USER'S APPLICABLE LICENSE AGREEMENT.

The manufacturer of this documentation is Computer Associates International, Inc.

Provided with “Restricted Rights” as set forth in 48 C.F.R. Section 12.212, 48 C.F.R. Sections 52.227-19(c)(1) and
(2) or DFARS Section 252.227.7013(c)(1)(ii) or applicable successor provisions.

First Edition, July 2000

 1987-2000 Computer Associates International, Inc.

One Computer Associates Plaza, Islandia, NY 11749
All rights reserved.

All trademarks, trade names, service marks, or logos referenced herein belong to their respective companies.
Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Chapter 1. Welcome to the Application Program Interface . . . . . . . . . . . . 1-1

1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
1.1.1 Assumed Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.2 Endevor for OS/390 API Architecture . . . . . . . . . . . . . . . . . . . . . . . 1-5
1.3 API Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.1 The Control Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.2 The Request Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.3 The Response Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
1.4 API Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
1.5 Initializing API Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.5.1 Assembler Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.5.2 COBOL Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.6 Starting Up and Shutting Down the API Server . . . . . . . . . . . . . . . . . 1-13
1.7 Calling the API from an Assembler Program . . . . . . . . . . . . . . . . . . 1-14
1.8 Calling the API from a COBOL Program . . . . . . . . . . . . . . . . . . . . 1-15
1.9 Checking API Return and Reason Codes . . . . . . . . . . . . . . . . . . . . . 1-16
1.10 Writing Messages to the Message File . . . . . . . . . . . . . . . . . . . . . 1-17
1.11 Writing Responses to an Output File . . . . . . . . . . . . . . . . . . . . . . 1-18
1.12 Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19

Chapter 2. API Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.2 Control Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.2.1 AACTL Control Structure Fields . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3 API Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.3.1 Understanding Logical and Physical Mapping Requests . . . . . . . . . . . 2-6
2.4 Add Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.4.1 AEADD_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-8
2.5 Delete Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
2.5.1 AEDEL_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-10
2.6 Extract Element and Component Data . . . . . . . . . . . . . . . . . . . . . . 2-12
2.6.1 Element and Component Extraction Types . . . . . . . . . . . . . . . . . 2-12
2.6.2 AEELM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-13
2.6.3 AEELM_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-14
2.6.4 Element Extract and Component Data Record Layouts . . . . . . . . . . 2-14
2.6.4.1 Element Extract, No Format Record Layout . . . . . . . . . . . . . . 2-15
2.6.4.2 Element Extract, Browse Record Layout . . . . . . . . . . . . . . . 2-15
2.6.4.3 Element Extract, Change Record Layout . . . . . . . . . . . . . . . 2-16
2.6.4.4 Element Extract, History Record Layout . . . . . . . . . . . . . . . . 2-16
2.6.4.5 Component Extract, Browse Record Layout . . . . . . . . . . . . . . 2-17
2.6.4.6 Component Extract, Change Record Layout . . . . . . . . . . . . . . 2-18
2.6.4.7 Component Extract, History Record Layout . . . . . . . . . . . . . . 2-19
2.7 Generate Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
2.7.1 AEGEN_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-21

Contents iii
 2.8 List Approver Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
2.8.1 ALAGR_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-23
2.8.2 ALAGR_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-23
2.9 List Approver Group Junctions . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
2.9.1 ALAGJ_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-25
2.9.2 ALAGJ_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-26
2.10 List Data Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
2.10.1 ALDSN_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-27
2.10.2 ALDSN_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-28
2.11 List Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
2.11.1 ALELM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-29
2.11.2 ALELM_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-30
2.11.2.1 Information About the Last Action . . . . . . . . . . . . . . . . . . 2-31
2.11.2.2 Information About the Element Base . . . . . . . . . . . . . . . . . 2-32
2.11.2.3 Information About the Element Delta (Last Level) . . . . . . . . . 2-32
2.11.2.4 Information About the Component List Base . . . . . . . . . . . . 2-33
2.11.2.5 Information About the Component List Delta . . . . . . . . . . . . 2-33
2.11.2.6 Information About the Last Element Move . . . . . . . . . . . . . 2-33
2.11.2.7 Information About the Last Add or Update Data Set . . . . . . . . 2-34
2.11.2.8 Information About the Element Processor Execution . . . . . . . . 2-34
2.11.2.9 Information About the Last Element Retrieve . . . . . . . . . . . . 2-35
2.11.2.10 Information About the Package Last Executed Against the Element
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
2.11.2.11 Information About the Package Last Executed Against the Element
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
2.11.2.12 Information About the Last "FROM" Endevor location . . . . . . 2-35
2.11.2.13 Other Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
2.12 List Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
2.12.1 ALENV_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-37
2.12.2 ALENV_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-38
2.13 List Processor Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
2.13.1 ALPGR_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-40
2.13.2 ALPGR_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-41
2.14 List Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
2.14.1 ALSIT_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-43
2.14.2 ALSIT_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-43
2.15 List Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
2.15.1 ALSTG_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-47
2.15.2 ALSTG_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-48
2.16 List Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
2.16.1 ALSBS_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-49
2.16.2 ALSBS_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-50
2.17 List System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
2.17.1 ALSYS_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-52
2.17.2 ALSYS_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-53
2.18 List Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
2.18.1 ALTYP_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-55
2.18.2 ALTYP_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-56
2.19 Move Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-59
2.19.1 AEMOV_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . 2-59

iv Endevor for OS/390 API Guide

2.20 Print Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
2.20.1 AEPRE_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-61
2.21 Print Member Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
2.21.1 AEPRM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-63
2.22 Retrieve Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
2.22.1 AERET_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-64
2.23 Signin Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
2.23.1 AESIG_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-66
2.24 Transfer Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
2.24.1 AETRA_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-68
2.25 Update Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-71
2.25.1 AEUPD_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-71

Chapter 3. API Return Codes and Reason Codes . . . . . . . . . . . . . . . . . 3-1

3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.2 Return Code and Reason Code Descriptions . . . . . . . . . . . . . . . . . . . . 3-4

Chapter 4. API Execution Reports and Trace Facilities . . . . . . . . . . . . . . 4-1

4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.1 Execution Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.2 Trace Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.2 API Execution Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4.2.1 Element Action Function Call Sample Report . . . . . . . . . . . . . . . . 4-4
4.2.2 Inventory List Function Sample Report . . . . . . . . . . . . . . . . . . . . 4-5
4.3 The API Diagnostic Trace — BC1PAPI . . . . . . . . . . . . . . . . . . . . . . 4-7
4.4 The API Internal Trace — EN$TRAPI . . . . . . . . . . . . . . . . . . . . . . . 4-8

Appendix A. Sample API Programs . . . . . . . . . . . . . . . . . . . . . . . . A-1

A.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
A.2 Executing an API Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
A.2.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
A.3 Sample COBOL Program — CCIDRPT1 . . . . . . . . . . . . . . . . . . . . A-6
A.3.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
A.3.2 CCIDRPT1 Output Report . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
A.4 JCL to Execute CCIDRPT1 — BC1JRAPI . . . . . . . . . . . . . . . . . . . A-8
A.4.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
A.5 Sample List Environment Function Call — ENHAAPGM . . . . . . . . . . . A-11
A.5.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
A.6 JCL to Execute ENHAAPGM — BC1JAPGM . . . . . . . . . . . . . . . . . A-12
A.6.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12
A.7 Sample Element Action Function Call — ENHAEPGM . . . . . . . . . . . . A-14
A.7.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14
A.8 JCL to Execute ENHAEPGM — BC1JEPGM . . . . . . . . . . . . . . . . . A-15
A.8.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
A.9 Sample Inventory List Function Call — ENTBJAPI . . . . . . . . . . . . . . A-17
A.9.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17
A.10 JCL to Execute ENTBJAPI — BC1JAAPI . . . . . . . . . . . . . . . . . . . A-18
A.10.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-18

Contents v
vi Endevor for OS/390 API Guide
About This Guide

This document introduces the Endevor for OS/390 Application Program Interface (API).
The Endevor for OS/390 API lets you retrieve and update information programmatically
from Assembler or an LE-compliant language. This document describes how to use the
API and describes sample programs and contains sample JCL to help you implement the
API. It contains the following chapters:

Chapter 1 — Introduces the Endevor for OS/390 Application Program Interface
(API).

Chapter 2 — Describes the parameters in the API structures.

Chapter 3 — Describes API response and reason codes.

Chapter 4 — Describes the API execution reports and trace facilities.

Appendix A — Describes sample programs and JCL streams.

Related Documentation

Refer to the following manuals for more information about Endevor for OS/390.

For the administrator:

Endevor for OS/390 Administration Guide — Describes how to define inventory and
life cycle models, as well as define and maintain maps, security classes, user profiles,
and network security.

Endevor for OS/390 Automated Configuration Manager — Introduces Software Con-
figuration Management, explains how to enable and use the Endevor Automated Con-
figuration Manager, and describes how to use the Endevor Software Control
Language along with the data Endevor ACM collects to perform change impact anal-
ysis.

Endevor for OS/390 CSP Interface Guide — Provides an introduction to the Endevor
for CSP product, describes how to install the product (Releases 3.3 and 4.1), and
explains administrative, processing, and environment functions.

Endevor for OS/390 Exits — Describes how to use exit programs with Endevor, by
identifying the exits that you want to use, writing the exits, and including them in the
user exits table.

Endevor for OS/390 Footprints — Explains footprints and how to install and use
Endevor's remote footprint synchronization facility. You will also learn about
Endevor's transportable footprint capability and how to utilize footprint reports.

Endevor for OS/390 Implementation Guide — Introduces basic Endevor concepts that
system administrators should read before implementing Endevor. It provides an
overview of Endevor and information about implementation for source, output, or
configuration management; working with elements; and security.

About This Guide vii


Endevor for OS/390 Information/Management Interface Administration Guide — Dis-
cusses the Information/Management Interface. This guide also provides background
information and discusses how you can manage the interface as an administrator.

Endevor for OS/390 Installation Guide — Explains how to install and implement the
Endevor system.

Endevor for OS/390 Inventory Analyzer — Shows how to use the Endevor Inventory
Analyzer. This guide also provides a description of the reports produced by the
Inventory Analyzer.

Unicenter TNG Framework for OS/390 for the CA-L-Serv Technical Bulletin — Dis-
cusses additional detailed information about how to implement CA-L-Serv in con-
junction with all supported releases of Endevor for OS/390 for the purpose of
managing and improving access performance against Endevor's VSAM Master
Control File (MCF), Package Dataset, and Endevor LIB (VSAM) Data Sets.

Endevor for OS/390 Packages — Describes Endevor packages, how to process pack-
ages in the foreground; perform package processing in batch; define approver groups
and approver group relationships; use the package shipment utility.

Endevor for OS/390 Processors — Discusses how to write, classify, and manage
processors. This guide further discusses processor utilities and processor groups.

Endevor for OS/390 Quick Reference Guide for Administrators — Provides a quick
reference for Endevor administrative functions.

Endevor for OS/390 Reports — Describes the different categories of reports you can
obtain using Endevor and explains how to generate these reports.

Endevor for OS/390 CA-Roscoe Interface — Describes how to install the Endevor for
OS/390 CA-Roscoe Interface. This guide also explains interface foreground proc-
essing and interface batch processing with CA-Roscoe.

Endevor for OS/390 Security Guide — Explains how to set up both native security
and the external security interface (ESI).

Endevor for OS/390 Utilities — Provides background on working with files, Endevor
LIB Data Sets, and load module support. This guide also discusses the utilities you
can use to define and maintain information stored by Endevor.

CA-Netman Interface Administration Guide — Discusses the CA-Netman Interface.
This guide also provides background information and discusses how you can manage
the interface as an administrator.

For the user:

Endevor for OS/390 Error Codes and Messages — Provides explanations and courses
of action for messages and codes generated by Endevor.

Endevor for OS/390 Quick Edit User Guide — Explains how to install and use
Endevor Quick Edit at your site.

Endevor for OS/390 Quick Reference Guide for Users — Provides a quick reference
for Endevor actions and SCL syntax.

viii Endevor for OS/390 API Guide


Endevor for OS/390 SCL Reference Manual — Provides an overview of SCL, lists
SCL coding conventions, and presents the definitions and syntax for SCL statements.

Endevor for OS/390 User Guide — Provides an overview of the system and its con-
cepts, as well as instructions for setting user options, displaying information, and
managing source.

Endevor for OS/390 PDM User Guide — Explains how to use Endevor PDM to
manage concurrent development and vendor application maintenance activities.

About This Guide ix

x Endevor for OS/390 API Guide
Chapter 1. Welcome to the Application Program
Interface

1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

1.1.1 Assumed Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
1.2 Endevor for OS/390 API Architecture . . . . . . . . . . . . . . . . . . . . . . . 1-5
1.3 API Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.1 The Control Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.2 The Request Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
1.3.3 The Response Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
1.4 API Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
1.5 Initializing API Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.5.1 Assembler Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.5.2 COBOL Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1.6 Starting Up and Shutting Down the API Server . . . . . . . . . . . . . . . . . 1-13
1.7 Calling the API from an Assembler Program . . . . . . . . . . . . . . . . . . 1-14
1.8 Calling the API from a COBOL Program . . . . . . . . . . . . . . . . . . . . 1-15
1.9 Checking API Return and Reason Codes . . . . . . . . . . . . . . . . . . . . . 1-16
1.10 Writing Messages to the Message File . . . . . . . . . . . . . . . . . . . . . 1-17
1.11 Writing Responses to an Output File . . . . . . . . . . . . . . . . . . . . . . 1-18
1.12 Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19

Chapter 1. Welcome to the Application Program Interface 1-1

1-2 Endevor for OS/390 API Guide
 1.1 Overview

1.1 Overview

Endevor for OS/390 is a comprehensive, automated solution for managing the entire soft-
ware development life cycle. From initial design through distribution, it guarantees con-
sistency and control through process automation and life cycle administration.

Endevor for OS/390 provides an Application Program Interface, or API, which lets you
retrieve and update the Master Control File (MCF) and base and delta information pro-
grammatically from programs written in Assembler or an LE-compliant language that run
on platforms supported by IBM's OS/390 operating system.

Endevor functions supported by the API can be categorized into three groups:

Inventory Query and List Functions
Allows you to request inventory lists and perform queries. This includes elements,
environments, systems, subsystems, and all other inventory information stored in the
MCF.

Element Extract
Allows you to extract element and/or component source from the base and delta
libraries. Also, you can extract summary, changes, and history information associ-
ated with element or component data.

Element Actions
Allows you to perform one of the element actions, such as ADD, GENERATE,
MOVE, or PRINT ELEMENT. These functions retrieve information from the MCF
and base and delta libraries, and may update these files, depending on the function.
The SCL SET OPTIONS clause is not supported. All SCL syntax is supported
unless otherwise noted. For more information, see the Endevor for OS/390 SCL Ref-
erence Manual.
Actions not supported include:
– ARCHIVE
– COPY
– LIST from archive
– LIST member from external library
– RESTORE
– TRANSFER element to archive data set
– TRANSFER from archive data set or unload tape

Chapter 1. Welcome to the Application Program Interface 1-3

1.1 Overview

1.1.1 Assumed Knowledge

To use the Endevor API, we assume that you are familiar with Endevor for OS/390. In
addition, knowledge of COBOL or Assembler programming concepts is expected.
Finally, you must be familiar with both the layout and runtime usage of structures; the
API uses structures to request and receive information from Endevor for OS/390.

1-4 Endevor for OS/390 API Guide

 1.2 Endevor for OS/390 API Architecture

1.2 Endevor for OS/390 API Architecture

To invoke the Endevor API, an application program calls the Endevor API interface
program, ENA$NDVR, passing it two or three parameters: the control structure, a request
structure, and, depending on the function call, a response structure. List and extract func-
tion calls require all three structures. Element action function calls require the control
and request structures.

Note: Your program that invokes the API must reside in an authorized library. No other
restrictions apply to compiling or linking a user program.

On the first function call to the ENA$NDVR interface program, the Endevor API server
is attached and initialized. The user's request is processed and the results are placed into
the response structure if it exists. The control structure is also updated with return code
and reason code information. The API server remains active and is available to process
additional requests until a request is received to shutdown the API.

The following diagram shows how the Endevor for OS/390 API processes an API func-
tion call:

You can also use the CONAPI utility to execute a program that issues API function calls
from an Endevor for OS/390 processor. For more information about this utility, see
Endevor for OS/390 Processors.

To execute a program that issues API function calls outside of a processor, see A.2,
“Executing an API Program” on page A-4.

Chapter 1. Welcome to the Application Program Interface 1-5

1.3 API Structures

1.3 API Structures

There is one control structure used for all types of function calls and a unique request and
response structure for each type of function call. Each structure consists of a header area,
followed by a data area. It is the responsibility of the user program to initialize all the
structures prior to calling the API and to populate some of the data area fields in the
control and request structures.

The API Assembler macros and COBOL copybooks are provided in iprfx.iqual.SOURCE
for each API function call.

The structure naming conventions are as follows:

Name Description
ExHAACTL Control structure. Where x is H for Assembler macro and C for
COBOL copybook.
ExHAExxx API function call. Where x is H for Assembler macro and C for
COBOL copybook. Where xxx is the Endevor function.

1.3.1 The Control Structure

The control structure contains fields that:

Start up and shutdown the API server.

Define the message and output files where the information from each function call is
placed. Each API function call opens and closes an output file. If two or more API
function calls use the same output file, only the response to the last function call is
maintained; data from the prior function call is overwritten.

Contain the reason and return codes about the function call that you have performed.

For a description of the data areas included in the control structure, see 2.2, “Control
Structure” on page 2-4.

1.3.2 The Request Structure

The request structure contains the fields required to perform an API function call. In this
structure, you define location information and action options.

1-6 Endevor for OS/390 API Guide

 1.3 API Structures

1.3.3 The Response Structure

The response structure allows you to specify where and how you want the response to
your function call stored. On list function calls, this structure defines the area where the
first response that satisfies the function call is placed. Optionally, a complete list of
responses is written to an output file that you define in the control structure. The
response records written to the output file have the same format as the response structure.

For extract function calls, the response structure specifies control information about your
request.

Response structures are not applicable for element action function calls.

Chapter 1. Welcome to the Application Program Interface 1-7

1.4 API Function Calls

1.4 API Function Calls

The Endevor for OS/390 API provides Assembler macros and corresponding COBOL
copybooks that correspond to the function calls. These are delivered in the
iprfx.iqual.SOURCE data set.

For each Assembler API macro, except the initialization macro, API$INIT, there is a cor-
responding COBOL copybook with a similar name. For example, the ENHALENV
Assembler macro has a corresponding COBOL copybook of a similar name except that
Assembler macros begin with ENH and COBOL copybooks begin with ECH. In addi-
tion, COBOL users have a copybook, ENCCNST, that contains Endevor for OS/390 API
constants.

The following table summarizes the types of API function calls that you can make and
their corresponding structure names. Each extract and list function call has its own
unique request and response structure. Response structures are not applicable for element
action function calls. Where x is H for Assembler macros and C for COBOL copybooks.

API Function Call Macro/Copybook Request Structure Response Structure

Name Name Name
Add Element ExHAEADD AEADD_RQ N/A
Defines the parameters necessary to
add an element.
Delete Element ExHAEDEL AEDEL_RQ N/A
Defines the parameters necessary to
delete an element.
Extract Element/Component Request ExHAEELM AEELM_RQ AEELM_RS
Extracts the element source or element
component information from an
explicit Endevor location and element
level into your specified file.
Generate Element ExHAEGEN AEGEN_RQ N/A
Defines the parameters necessary to
generate an element.
List Approver Group ExHALAGR ALAGR_RQ ALAGR_RS
Extracts approver group information
for an environment.

1-8 Endevor for OS/390 API Guide

 1.4 API Function Calls

API Function Call Macro/Copybook Request Structure Response Structure

Name Name Name
List Approver Group Junction ExHALAGJ ALAGJ_RQ ALAGJ_RS
Extracts approver junction information
for an environment.
List Dataset ExHALDSN ALDSN_RQ ALDSN_RS
Extracts Endevor data set information
under an environment, stage, and
system.
List Element ExHALELM ALELM_RQ ALELM_RS
Extracts element information for an
environment and also mapped
locations.
List Environment ExHALENV ALENV_RQ ALENV_RS
Extracts environment information and
also mapped environments.
List Processor Group ExHALPGR ALPGR_RQ ALPGR_RS
Extracts processor information
including the symbolic overrides under
an environment, stage, system, and
type.
List Site ExHALSIT ALSIT_RQ ALSIT_RS
Extracts the site's definition.
List Stage ExHALSTG ALSTG_RQ ALSTG_RS
Extracts stage information for an envi-
ronment and also mapped stages.
List Subsystem ExHALSBS ALSBS_RQ ALSBS_RS
Extracts subsystem information for an
environment and also mapped subsys-
tems.
List System ExHALSYS ALSYS_RQ ALSYS_RS
Extracts system information for an
environment and also mapped systems.
List Type ExHALTYP ALTYP_RQ ALTYP_RS
Extracts type information for an envi-
ronment and also mapped types.

Chapter 1. Welcome to the Application Program Interface 1-9

1.4 API Function Calls

API Function Call Macro/Copybook Request Structure Response Structure

Name Name Name
Move Element ExHAEMOV AEMOV_RQ N/A
Defines the parameters necessary to
move an element.
Print Element ExHAEPRE AEPRE_RQ N/A
Defines the parameters necessary to
print an element.
Print from External Library ExHAEPRM AEPRM_RQ N/A
Defines the parameters necessary to
print a member from an external
library.
Retrieve Element ExHAERET AERET_RQ N/A
Defines the parameters necessary to
retrieve an element.
Signin Element ExHAESIG AESIG_RQ N/A
Defines the parameters necessary to
sign in an element.
Transfer Element ExHAETRA AETRA_RQ N/A
Defines the parameters necessary to
transfer an element.
Update Element ExHAEUPD AEUPD_RQ N/A
Defines the parameters necessary to
update an element.

COBOL Users: COBOL copybook field names are similar to the names used by the
Assembler macros except that COBOL substitutes the underscore character (_) with a
hyphen (-). For example, ALELM_RQ_PATH appears as ALELM-RQ-PATH.

See Chapter 2, “API Function Calls” on page 2-1 for detailed information about each
API function call and its use.

1-10 Endevor for OS/390 API Guide

 1.5 Initializing API Structures

1.5 Initializing API Structures

Before you issue an API function call, you must first initialize the control, request, and
response structures passed with the API function call. It is the responsibility of the user
program to initialize all the structures prior to calling the API and to populate some of
the data area fields in the control and request structures.

The following sections explain how to initialize API structures in Assembler and COBOL
programs.

1.5.1 Assembler Programs

Assembler users can use the API$INIT macro to initialize the control, request, and
response structures. Each structure has a fixed formatted header and can be initialized by
using API$INIT.

Note: The twelve-character header must not be initialized or modified by the user
program. If it is, the API function call fails with an "invalid request structure"
error condition. The initialization macro, API$INIT properly sets the header
information.

To initialize the ENHAACTL control structure, use this statement:

API$INIT STG=AACTL,BLOCK=AACTL

To initialize a request or response structure, use this API$INIT syntax:

API$INIT STG=structure_name,BLOCK=structure_name

where structure-name is the name of the API macro request or response structure.

For example, these statements initialize the request and response structure for the list
environment macro, ENHLENV:
API$INIT STG=ALENV_RQ,BLOCK=ALENV_RQ
API$INIT STG=ALENV_RS,BLOCK=ALENV_RS

1.5.2 COBOL Programs

To initialize API storage structures in COBOL programs, move blanks, zeros, or explicit
values in the fields, depending on the field type.
Note: COBOL copybook field names are similar to the names used by the Assembler
macros except:

COBOL substitutes the underscore character (_) with a hyphen (-). For
example, AACTL_SHUTDOWN appears as AACTL-SHUTDOWN and
ALELM_RQ appears as ALELM-RQ.

Chapter 1. Welcome to the Application Program Interface 1-11

1.5 Initializing API Structures

COBOL does not allow the use of the pound character (#). For example,
AACTL_#SELECTED appears as AACTL-SELECTED.

The code below shows how to initialize the ECHAACTL control structure:
INITIALIZE AACTL-DATAAREA.

This code shows an example of initializing the request and response data portion of the
ECHALELM copybook.
INITIALIZE ALELM-RQ-DATAAREA.
INITIALIZE ALELM-RS-DATAAREA.
Note: The control, request, and response header portions of each copybook are initial-
ized by COBOL value clauses. These values must not be changed.

1-12 Endevor for OS/390 API Guide

 1.6 Starting Up and Shutting Down the API Server

1.6 Starting Up and Shutting Down the API Server

Your first API function call automatically starts the API server, which transfers data to
and from Endevor for OS/390 and your application program. Your last API function call
must shut the API server down.

To shut down the API server, set the ECHAACTL Shutdown field to 'Y'. Below is an
example of COBOL code setting the AACTL-SHUTDOWN field to 'N':
MOVE 'N' TO AACTL-SHUTDOWN.

Chapter 1. Welcome to the Application Program Interface 1-13

1.7 Calling the API from an Assembler Program

1.7 Calling the API from an Assembler Program

The following Assembler code shows a sample API function call for a list environment
request. The code:
1. Begins by defining the control structure through the ENHAACTL macro, and the list
environment function call request and response structures through the ENHALENV
macro.
2. Initializes the ENHAACTL control structure, sets the API server Shutdown field
(AACTL_SHUTDOWN) to 'N', and sets the DD names of the message and list envi-
ronment output files.
3. Initializes the list environment function call request and response structures.
4. Defines the search criteria for the function call; in this case, the ALENV_RQ fields
are set to conduct a logical search in all environments and return after finding the
first occurrence.
5. Loads the addresses of the ENHAACTL control structure, ALENV_RQ request struc-
ture, and ALENV_RS response structure in a parameter list stored in register 1.
6. Calls the API server using the ENA$NDVR interface program.
ENHAACTL DSECT=NO
ENHALENV DSECT=NO
PARMLIST DC 3F'+'
API$INIT STG=AACTL,BLOCK=AACTL Initialize the ctl block
MVC AACTL_SHUTDOWN,C'N' Do not shutdown API server
MVC AACTL_MSG_DDN,=CL8'MSG3FILE' Set Message DD name
MVC AACTL_LIST_DDN,=CL8'EXT1ELM' Set DD name for List Env
API$INIT STG=ALENV_RQ,BLOCK=ALENV_RQ Initialize the req block
API$INIT STG=ALENV_RS,BLOCK=ALENV_RS Initialize the rsp block
MVI ALENV_RQ_PATH,C'L' Set to Logical Search
MVI ALENV_RQ_RETURN,C'F' Set to return first hit
MVI ALENV_RQ_SEARCH,C'A' Set search to ALL
MVC ALENV_RQ_ENV,=CL8'PRDENV' Set the environ name
LA R1,PARMLIST Set up the parm list
LA R14,AACTL R1 -> parmlist
ST R14,+(+,R1) +(,R1) = A(AACTL)
LA R14,ALENV_RQ 4(,R1) = A(ALENV_RQ)
ST R14,4(+,R1) 8(,R1) = A(ALENV_RS)
LA R14,ALENV_RS
ST R14,8(+,R1)
OI 8(R1),X'8+' TURN ON HIGHORDER BIT
L R15,=V(ENA$NDVR)
BALR R14,R15 CALL SERVER THRU ENA$NDVR

1-14 Endevor for OS/390 API Guide

 1.8 Calling the API from a COBOL Program

1.8 Calling the API from a COBOL Program

Copybooks are provided for all API structures. Below are examples of API function calls
from a COBOL program. Note that the first parameter refers to a control structure, the
second a request structure which is followed by a response structure:

Template for List and Extract Function Call

CALL EAC-ENDEVOR-APINAME USING AACTL ALELM-RQ ALELM-RS.

Template for Element Action Function Call

CALL EAC-ENDEVOR-APINAME USING AACTL AEGEN-RQ.

In the above examples, EAC-ENDEVOR-APINAME contains the name of the Endevor

for OS/390 API interface program which is set to the value of ENA$NDVR.

In the first example, ALELM-RQ describes a list element request structure and the
ALELM-RS describes the list element response structure. Through the request structure,
Endevor inventory data, pathing information, and return options are specified. After the
API processes the list element request, it places the first response in the list element
response structure, ALELM-RS. All data responses, including the first, are written to the
file identified by the AACTL-LIST-DDN field. If this field is not specified, no responses
are written to this file.

Chapter 1. Welcome to the Application Program Interface 1-15

1.9 Checking API Return and Reason Codes

1.9 Checking API Return and Reason Codes

Once the API server processes an API function call, it is recommended to check the
return and reason codes returned to the control structure. The return code indicates the
severity of the error and the reason code indicates the cause of the error. For example,
return code 04 combined with reason code 002 indicates a warning message resulting
from not finding a requested stage. See Chapter 3, “API Return Codes and Reason
Codes” on page 3-1 for a compete list of the return and reason codes you might expect
to get.

To check the return and reason codes returned from an API function call, examine the
AACTL_RTNCODE and AACTL_REASON fields in the control structure. You can also
check the return code value in register 15. Your return code will be one of the following
values:

Return Code Description

00 I - Informational. Processing concluded normally. Message is issued
for informational purposes only.
04 W - Warning. An error was encountered which was not serious enough
to terminate processing.
08 C - Caution. An error was encountered which may prevent further
processing.
12 E - Error. An error was encountered that terminated processing of the
current action but allowed Endevor to continue with the next action
request.
16 S - Severe. A severe error was encountered that prevented Endevor
from completing the requested action. Processing will terminate imme-
diately. This category includes internal, system, and I/O errors.
20 F - Fatal. No further processing is possible.

In addition, you should check the value of the ACCTL_HI_MSGID field, which contains
one of the following values:

The highest API message ID encountered while processing the API function call.
The value of this field has the following format:
APIxxyyyz
where xx is the return code, yyy is the reason code, and z is the severity letter.

The error message ID returned by Endevor. This could be a source management
error, inventory management error, and so on.

1-16 Endevor for OS/390 API Guide

 1.10 Writing Messages to the Message File

1.10 Writing Messages to the Message File

You must define a message file to write output messages to. The API server writes the
messages to the message file DD name that you supply to the AACTL_MSG_DDN field.
Endevor messages, such as the Execution Report and Source and Inventory Management
errors (if any), are recorded to this data set. This is NOT a required field, but it is highly
recommended that a file name be provided. If one is not specified, a default DD name of
APIMSGS is used. It is the responsibility of the user to allocate this data set prior to
executing an API function call. For example, if your JCL contains the following DD
statement, assign MSG3FILE to the AACTL_MSG_DDN field:
//MSG3FILE DD DSN=&&MSG3FILE,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=FB,LRECL=133,BLKSIZE=133++)

The API server manages this file. It is not necessary to define, open, or close this file in
your application program.

Chapter 1. Welcome to the Application Program Interface 1-17

1.11 Writing Responses to an Output File

1.11 Writing Responses to an Output File

To write the API responses to a file, define an output file that has a variable block record
format and logical record length of 2048 bytes. For example:
//EXT1ELM DD DSN=&&EXT1ELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=VB,LRECL=2+48,BLKSIZE=228++)

The API server writes the responses to the output file DD name that you supply to the
AACTL_LIST_DDN field. The API server manages this file. It is not necessary to
define, open, or close this file in your application program unless you want to read it as
input after the API server has finished writing all the responses. If you are only per-
forming a query and do not need a file of responses, leave this field blank. The total
count of records selected is included in the Execution Report which is written to the
message file. For example, if your JCL contains the DD statement above, assign
EXT1ELM to the AACTL_LIST_DDN field.

1-18 Endevor for OS/390 API Guide

 1.12 Sample Applications

1.12 Sample Applications

To help you get started using the API, source code for sample COBOL and Assembler
programs is provided in the iprfx.iqual.SOURCE data set. Each of these programs issues
function calls to the API.

COBOL program, CCIDRPT1, produces a list of elements based on user input and
creates a CCID cross-reference report. This program is distributed as a source
module.

Assembler program, ENHAAPGM, issues a list environment function call to list all
the environments defined in the logical map and writes the output to a file. This
program is distributed as a source module.

Assembler program, ENHAEPGM, executes each of the element action function calls
and writes the responses to an output file. This program is distributed as a source
module.

Assembler program, ENTBJAPI, executes different inventory list function calls based
on input. With this program, you can get familiar with the various inventory list
function calls and the output that each function call generates. This program is dis-
tributed as a load module only.

Refer to Appendix A, “Sample API Programs” on page A-1 for additional information
and the JCL required to execute these programs.

Chapter 1. Welcome to the Application Program Interface 1-19

1-20 Endevor for OS/390 API Guide
Chapter 2. API Function Calls

2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

2.2 Control Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.2.1 AACTL Control Structure Fields . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3 API Function Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.3.1 Understanding Logical and Physical Mapping Requests . . . . . . . . . . . 2-6
2.4 Add Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.4.1 AEADD_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-8
2.5 Delete Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
2.5.1 AEDEL_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-10
2.6 Extract Element and Component Data . . . . . . . . . . . . . . . . . . . . . . 2-12
2.6.1 Element and Component Extraction Types . . . . . . . . . . . . . . . . . 2-12
2.6.2 AEELM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-13
2.6.3 AEELM_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-14
2.6.4 Element Extract and Component Data Record Layouts . . . . . . . . . . 2-14
2.6.4.1 Element Extract, No Format Record Layout . . . . . . . . . . . . . . 2-15
2.6.4.2 Element Extract, Browse Record Layout . . . . . . . . . . . . . . . 2-15
2.6.4.3 Element Extract, Change Record Layout . . . . . . . . . . . . . . . 2-16
2.6.4.4 Element Extract, History Record Layout . . . . . . . . . . . . . . . . 2-16
2.6.4.5 Component Extract, Browse Record Layout . . . . . . . . . . . . . . 2-17
2.6.4.6 Component Extract, Change Record Layout . . . . . . . . . . . . . . 2-18
2.6.4.7 Component Extract, History Record Layout . . . . . . . . . . . . . . 2-19
2.7 Generate Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
2.7.1 AEGEN_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-21
2.8 List Approver Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
2.8.1 ALAGR_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-23
2.8.2 ALAGR_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-23
2.9 List Approver Group Junctions . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25
2.9.1 ALAGJ_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-25
2.9.2 ALAGJ_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-26
2.10 List Data Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27
2.10.1 ALDSN_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-27
2.10.2 ALDSN_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-28
2.11 List Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29
2.11.1 ALELM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-29
2.11.2 ALELM_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-30
2.11.2.1 Information About the Last Action . . . . . . . . . . . . . . . . . . 2-31
2.11.2.2 Information About the Element Base . . . . . . . . . . . . . . . . . 2-32
2.11.2.3 Information About the Element Delta (Last Level) . . . . . . . . . 2-32
2.11.2.4 Information About the Component List Base . . . . . . . . . . . . 2-33
2.11.2.5 Information About the Component List Delta . . . . . . . . . . . . 2-33
2.11.2.6 Information About the Last Element Move . . . . . . . . . . . . . 2-33
2.11.2.7 Information About the Last Add or Update Data Set . . . . . . . . 2-34
2.11.2.8 Information About the Element Processor Execution . . . . . . . . 2-34
2.11.2.9 Information About the Last Element Retrieve . . . . . . . . . . . . 2-35

Chapter 2. API Function Calls 2-1

 2.11.2.10 Information About the Package Last Executed Against the Element
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
2.11.2.11 Information About the Package Last Executed Against the Element
Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35
2.11.2.12 Information About the Last "FROM" Endevor location . . . . . . 2-35
2.11.2.13 Other Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
2.12 List Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37
2.12.1 ALENV_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-37
2.12.2 ALENV_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-38
2.13 List Processor Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40
2.13.1 ALPGR_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-40
2.13.2 ALPGR_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-41
2.14 List Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
2.14.1 ALSIT_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . . 2-43
2.14.2 ALSIT_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-43
2.15 List Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
2.15.1 ALSTG_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-47
2.15.2 ALSTG_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-48
2.16 List Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49
2.16.1 ALSBS_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-49
2.16.2 ALSBS_RS Response Structure Fields . . . . . . . . . . . . . . . . . . . 2-50
2.17 List System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52
2.17.1 ALSYS_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-52
2.17.2 ALSYS_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-53
2.18 List Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-55
2.18.1 ALTYP_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-55
2.18.2 ALTYP_RS Response Structure Fields . . . . . . . . . . . . . . . . . . 2-56
2.19 Move Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-59
2.19.1 AEMOV_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . 2-59
2.20 Print Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61
2.20.1 AEPRE_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-61
2.21 Print Member Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63
2.21.1 AEPRM_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-63
2.22 Retrieve Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
2.22.1 AERET_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-64
2.23 Signin Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
2.23.1 AESIG_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-66
2.24 Transfer Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68
2.24.1 AETRA_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-68
2.25 Update Element Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-71
2.25.1 AEUPD_RQ Request Structure Fields . . . . . . . . . . . . . . . . . . . 2-71

2-2 Endevor for OS/390 API Guide

 2.1 Overview

2.1 Overview

This chapter describes the fields contained in the control structure and the request and
response structures for each Endevor for OS/390 API function call. The information is
presented in alphabetic order by the name of the API function call. The Assembler
macro layouts and COBOL copybook layouts are delivered in the iprfx.iqual.SOURCE
installation library.

Before issuing an API function call, you must initialize the control, request, and response
structures. You must also populate some of the data areas in the control and request
structures. For instructions on initializing structures, see 1.5, “Initializing API Structures”
on page 1-11.

Chapter 2. API Function Calls 2-3

2.2 Control Structure

2.2 Control Structure

The control stucture contains the fields that allow you to shutdown the API server as well
as define the output files where the information from each function call is placed. It also
contains the reason and return codes which provide information about the function call
that you have performed.

The first call to the API server automatically starts it. For each new API function call,
the control structure must be modified. The server remains open until the SHUTDOWN
field is set to Y.

The control structure also contains the information about the output files used by the API
on each function call. Each function call opens and closes an output file which is defined
in this structure. If two or more function calls use the same output file, only the response
to the last function call is maintained. Data from the prior function call is overwritten.

Assembler: ENHAACTL

COBOL: ECHAACTL

2.2.1 AACTL Control Structure Fields

The following table contains a list of the fields contained in the control structure and the
options available to you.

Field Length Description

AACTL_MSG_DDN Character 8 Message file DD name. Endevor mes-
sages, such as the Execution Report and
Source and Inventory Management errors
(if any), are recorded to this data set.
This is NOT a required field, but it is
highly recommended that a file name be
provided. If one is not specified, a
default DD name of APIMSGS is used.
It is the responsibility of the user to allo-
cate this data set prior to executing an
API function call.
AACTL_LIST_DDN Character 8 Output file DD name. List response
records and extract element response
records are recorded to this data set.
This is NOT a required field and is not
used by the API element action proc-
essing.

2-4 Endevor for OS/390 API Guide

 2.2 Control Structure

Field Length Description

AACTL_HI_MSGID Character 8 The API updates this field with the
highest message id encountered while
processing the request.
Format: APIxxyyyz
where xx = return code
yyy = reason code
z = severity letter
AACTL_SHUTDOWN Character 1 API server Startup/Shutdown flag. Set
to N to invoke the API server. Set to Y
after processing the request to shutdown
the server.
AACTL_RTNCODE Character 4 Return code from processing the request.
Updated by the API. See Chapter 3,
“API Return Codes and Reason Codes”
on page 3-1 for more information.
AACTL_REASON Character 4 Reason code from processing the
request. Updated by the API. See
Chapter 3, “API Return Codes and
Reason Codes” on page 3-1 for more
information.
AACTL_#SELECTED Character 8 Number of selected list responses or
number of extracted element/component
records.
Note: This field is not used by the
element action function calls.
AACTL_#RETURNED Character 8 Number of returned list responses or
number of extracted element/component
records.
Note: This field is not used by the
element action function calls.
AACTL_STOPRC Character 2 Maximum allowable processing return
code. If not specified, the default is 16.
This value is used only when
wildcarding on the request causes more
than one action to be executed (example:
add elements aa through bb or generate
element a*).

Chapter 2. API Function Calls 2-5

2.3 API Function Calls

2.3 API Function Calls

Endevor functions supported by the API can be categorized into three groups:

Inventory Query and List Functions
Allows you to request inventory lists and perform queries. This includes elements,
environments, systems, subsystems, and all other inventory information stored in the
MCF.

Element Extract
Allows you to extract element and/or component source from the base and delta
libraries. Also, you can extract summary, changes, and history information associ-
ated with element or component data.

Element Actions
Allows you to perform one of the element actions, such as ADD, GENERATE,
MOVE, or PRINT ELEMENT. These functions retrieve information from the MCF
and base and delta libraries, and may update these files, depending on the function.

2.3.1 Understanding Logical and Physical Mapping Requests

Many request structures ask you to specify whether the mapping path is logical or phys-
ical:

Logical mapping refers to how the system administrator logically sets the route for
the inventory.

Physical mapping refers to a direct physical path.

Within an environment, inventory always goes from Stage 1 to Stage 2. But, when an
administrator maps across to another environment, the administrator may choose Stage 1
or Stage 2 of that environment. If the administrator chooses Stage 1 of the second
enviroment, Stage 1 and Stage 2 of that enviroment represent the route. If the adminis-
trator chooses Stage 2 of the second environment, Stage 1 of that environment does not
become part of the logical map, but does remain part of the physical map.

The example below illustrates the difference. Suppose you have Environment A and
Environment B, both with Stage 1 and Stage 2. Suppose further that the system adminis-
trator maps Environment A to Stage 2 of Environment B.

In a physical mapping, the inventory route always includes Stage 1 of Environment B

even though the system administrator maps to Stage 2:
1. Environment A / Stage 1
2. Environment A / Stage 2
3. Environment B / Stage 1

2-6 Endevor for OS/390 API Guide

 2.3 API Function Calls

4. Environment B / Stage 2

In a logical map, the inventory route bypasses Stage 1 of Environment B, and the inven-
tory route becomes:
1. Environment A / Stage 1
2. Environment A / Stage 2
3. Environment B / Stage 2

Chapter 2. API Function Calls 2-7

2.4 Add Element Action

2.4 Add Element Action

The add element action API function call allows you to add an element to Endevor.

Assembler: ENHAEADD

COBOL: ECHAEADD

2.4.1 AEADD_RQ Request Structure Fields

Immediately following the header is the data area of the AEADD_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

Field Length Description

AEADD_RQ_ELM Character 10 Element name
AEADD_RQ_ELM_THRU Character 10 Through element name
AEADD_RQ_DDN Character 8 File or DD name where member(s)
reside. Either DDN or DSN must be
specified, but not both.
AEADD_RQ_DSN Character 44 Data set name where member(s) reside.
Either DDN or DSN must be specified,
but not both.
AEADD_RQ_MBR Character 10 From PDS member name
AEADD_RQ_ENV Character 8 Environment name
AEADD_RQ_SYSTEM Character 8 System name
AEADD_RQ_SUBSYS Character 8 Subsystem name
AEADD_RQ_TYPE Character 8 Type name
AEADD_RQ_CCID Character 12 Change control id
AEADD_RQ_COMM Character 40 Comment
AEADD_RQ_NEWVER Character 2 New version (1-99)
AEADD_RQ_UPDT Character 1 Update if present (Y/N)
AEADD_RQ_DEL Character 1 Delete input source (Y/N)
AEADD_RQ_OVESIGNO Character 1 Override signout (Y/N)

2-8 Endevor for OS/390 API Guide

 2.4 Add Element Action

Field Length Description

AEADD_RQ_BYP_GEN Character 1 Bypass generate processor (Y/N)
AEADD_RQ_PROGRO Character 8 Processor group name
AEADD_RQ_RESERVE Character 3 ** Reserved field **

Chapter 2. API Function Calls 2-9

2.5 Delete Element Action

2.5 Delete Element Action

The delete element action API function call deletes an element from the specified inven-
tory location.

Assembler: ENHAEDEL

COBOL: ECHAEDEL

2.5.1 AEDEL_RQ Request Structure Fields

Immediately following the header is the data area of the AEDEL_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AEDEL_RQ_ELM Character 10 Element name
AEDEL_RQ_ELM_THRU Character 10 Through element name
AEDEL_RQ_ENV Character 8 Environment name
AEDEL_RQ_SYSTEM Character 8 System name
AEDEL_RQ_SUBSYS Character 8 Subsystem name
AEDEL_RQ_TYPE Character 8 Type name
AEDEL_RQ_STG_ID Character 1 Stage id. Either stage id or stage number
must be specified, but not both.
AEDEL_RQ_STG_NUM Character 1 Stage number (1/2). Either stage id or
stage number must be specified, but not
both.
AEDEL_RQ_CCID Character 12 Change control id
AEDEL_RQ_COMM Character 40 Comment
AEDEL_RQ_ONLY_ Character 1 Only delete components (Y/N)
COMP
AEDEL_RQ_OVESIGNO Character 1 Override signout (Y/N)
AEDEL_RQ_RESERVE Character 3 ** Reserved field **

2-10 Endevor for OS/390 API Guide

 2.5 Delete Element Action

Field Length Description

AEDEL_RQ_WCCID_ Character 1 Where CCID type (A/C/R). C is the
TYP default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AEDEL_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AEDEL_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

The first part is the prefix which contains the location, inventory classification, the
record number, and the record's data length.

The second part contains the element or component source data record.

Chapter 2. API Function Calls 2-11

2.6 Extract Element and Component Data

2.6 Extract Element and Component Data

The extract element and component data API function call extracts elements and compo-
nent data that match the criteria specified in the AEELM_RQ request structure and places
it in the output file defined in the control structure. AEELM_RS, the response structure,
contains information about the location and inventory classification of the element, as
well as the number of records returned by the function call and the record length of the
longest record.

Through the API, you can retrieve element data in both unformatted and formatted
display styles and component data in formatted display style. You can also retrieve
change and history information for both element and component data.

Assembler: ENHAEELM

COBOL: ECHAEELM

2.6.1 Element and Component Extraction Types

The extract element and component data function call provides seven types of extractions.
These are specified with the AEELM_RQ_FORMAT and the AEELM_RQ_RTYPE
fields:

The AEELM_RQ_RTYPE field determines whether element or component data is
extracted.

The AEELM_RQ_FORMAT field determines the format that the information will
appear in the output file.

The seven extraction types that result in different output record layouts are:

Extract Type Output Record Layout

Element extract Unformatted
Element extract, Browse Browse element record format
Element extract, Change Change element record format
Element extract, History History element record format
Component extract, Browse Browse component record format
Component extract, Change Change component record format
Component extract, History History component record format

2-12 Endevor for OS/390 API Guide

 2.6 Extract Element and Component Data

2.6.2 AEELM_RQ Request Structure Fields

Immediately following the header is the data area of the AEELM_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table:

Field Length Description

AEELM_RQ_FORMAT Character 1 Format type:
Blank = No format, just extract element
to output file; use only with RTYPE of
'E' (for element).
'B' = Endevor Browse format
'C' = Endevor Change format
'H' = Endevor History format
AEELM_RQ_RTYPE Character 1 Extraction record type:
'E' = Element
'C' = Component
AEELM_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.
AEELM_RQ_SYSTEM Character 8 System name. This field cannot contain
a wildcard character.
AEELM_RQ_SUBSYS Character 8 Subsystem name. This field cannot
contain a wildcard character.
AEELM_RQ_TYPE Character 8 Type name. This field cannot contain a
wildcard character.
AEELM_RQ_ELM Character 10 Element name. This field cannot contain
a wildcard character.
AEELM_RQ_STG_ID Character 1 Stage id. This field cannot contain a
wildcard character.
AEELM_RQ_VERSION Character 2 Version number. If not specified,
current version is assumed. Optional.
AEELM_RQ_LEVEL Character 2 Level number. If not specified, current
level is assumed. Optional.

Chapter 2. API Function Calls 2-13

2.6 Extract Element and Component Data

2.6.3 AEELM_RS Response Structure Fields

Immediately following its header is the data area of the AEELM_RS response structure.
The information contained in the response structure is explained in the following tables.

Field Length Description

AEELM_RS_SITE Character 1 Site id
AEELM_RS_ENV Character 8 Environment name
AEELM_RS_SYSTEM Character 8 System name
AEELM_RS_SUBSYS Character 8 Subsystem name
AEELM_RS_ELM Character 10 Element name
AEELM_RS_TYPE Character 8 Type name
AEELM_RS_STG_ID Character 1 Stage id
AEELM_RS_RECCNT Zoned Char 8 Number of records written to the
output file.
AEELM_RS_MAXLEN Zoned Char 8 Maximum record length encountered.

You can use the AEELM_RS_RECCNT and AEELM_RS_MAXLEN fields to determine

the number of records written to the output file and the maximum record length encount-
ered. The API server also identifies the record number and the record length for each
record it writes to the output file. For each record, it replaces:

The AEELM_RS_RECCNT field with the AEELM_RS_REC# (or in COBOL
AEELM-RS-RECNUM) field, which identifies the record number.

The AEELM_RS_MAXLEN field with the AEELM_RS_RECLEN field, which con-
tains the record length, excluding any headers.

2.6.4 Element Extract and Component Data Record Layouts

Each element record returned in this format has two parts:

The first part is the prefix which contains the location, inventory classification, the
record number, and the record length of the extracted element record.

The second part of the record contains the request element data.

Each component record returned has two parts:

The first part is the prefix which contains the location, inventory classification, record
number, and the record length of the specified element.

The second part of the record contains the requested component data, including infor-
mation about the component level, processor, symbol and macros.

The following sections show the record layouts for each extraction option.

2-14 Endevor for OS/390 API Guide

 2.6 Extract Element and Component Data

2.6.4.1 Element Extract, No Format Record Layout

The following example shows four records in hexadecimal format.

----------------------------------------------------------------------------------------------------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++8+TEST$API $MODNTRY LINKAGE=EXT,STACK=25+++,MSGDD=SYSPRINT
+4+++B++CCDDFCDE44444DCEDDEE4CCEC4444ECEE5CDC44CEDDCD44FFFFFFFFFFFFFFFFFECEE5CDC45DDCDEDE4DCDDCCC7CEE6EECCD7FFF
FF6DECCC7EEEDDCDE444444444444444444444444
+8++41+15539+953+++++5459452+2125++++3523B179++124774++1+++++++1++++++8+3523B179+B4645398+3952175E573B23132E25+
++B42744E28279953++++++++++++++++++++++++
--------------------------------------------------------------------------------------------------------------
-----------------------------------------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++8+ COPY $QIODS
+4+++B++CCDDFCDE44444DCEDDEE4CCEC4444ECEE5CDC44CEDDCD44FFFFFFFFFFFFFFFFF444444444CDDE445DCDCE444444444444444444
44444444444444444444444444444444444444444
+8++41+15539+953+++++5459452+2125++++3523B179++124774++1+++++++2++++++8++++++++++3678++B89642++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++
--------------------------------------------------------------------------------------------------------------
-----------------------------------------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++8+MAIN $FUNCSTG ,
+4+++B++CCDDFCDE44444DCEDDEE4CCEC4444ECEE5CDC44CEDDCD44FFFFFFFFFFFFFFFFFDCCD444445CEDCEEC46444444444444444444444
4444444444444444444444444444444444444444
+8++41+15539+953+++++5459452+2125++++3523B179++124774++1+++++++3++++++8+4195+++++B6453237+B+++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++
---------------------------------------------------------------------------------------------------------------
----------------------------------------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++8+GLOBALS +D
+4+++B++CCDDFCDE44444DCEDDEE4CCEC4444ECEE5CDC44CEDDCD44FFFFFFFFFFFFFFFFFCDDCCDE4444FC444444444444444444444444444
4444444444444444444444444444444444444444
+8++41+15539+953+++++5459452+2125++++3523B179++124774++1+++++++4++++++8+7362132+++++4+++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++
---------------------------------------------------------------------------------------------------------------
----------------------------------------

2.6.4.2 Element Extract, Browse Record Layout

The following example shows the first 26 records found in the Browse Display format.
In this example, the records shown have been truncated for display purposes. To view a
complete record, invoke Endevor for OS/390 on-line and go to the Display Element
menu. Select Browse Option against any element.

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK ELEMENT BROWSE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM: NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE: I
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79-------------------------- SOURCE LEVEL INFORMATION------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COMM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ----
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 395 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 584 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 395 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 1+FEB++ 13:19 584 JOAPI add o
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99GENERATED OLEJU+1 1+FEB++ 13:19 JOAPI add o
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++88+++ TEST$API $MODNTRY LINKAGE=EXT,STACK=25+++,MSGDD=SYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++88+++ COPY $QIODS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++88+++ MAIN $FUNCSTG ,
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++88+++ GLOBALS DS +D
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++88+++ WDBLWORD DS D

Chapter 2. API Function Calls 2-15

2.6 Extract Element and Component Data

2.6.4.3 Element Extract, Change Record Layout

The following example shows the first 26 records found in the Change Display format.
In this example, the records shown have been truncated for display purposes. To view a
complete record, invoke Endevor for OS/390 on-line and go to the Display Element
menu. Select Change Option against any element.

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK ELEMENT CHANGES
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM: NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79-------------------------- SOURCE LEVEL INFORMATION------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ---
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 395 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 584 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 395 JOAPI kee
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 1+FEB++ 13:19 584 JOAPI add
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99GENERATED OLEJU+1 1+FEB++ 13:19 JOAPI add
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++88++3 WINDEX_ALTYP EQU 7 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++88++3 WINDEX_ALPGR EQU 8 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++88++3 WINDEX_ALDSN EQU 9 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++88++3 WINDEX_ALAGR EQU 1+ . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++88++3 WINDEX_ALAGJ EQU 11 . . .

2.6.4.4 Element Extract, History Record Layout

The following example shows the first 38 records found in the History Display format.
In this example, the records shown have been truncated for display purposes. To view a
complete record, invoke Endevor for OS/390 on-line and go to the Display Element
menu. Select the History Option against any element.

2-16 Endevor for OS/390 API Guide

 2.6 Extract Element and Component Data

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK ELEMENT BROWSE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM:NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE I
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79-------------------------- SOURCE LEVEL INFORMATION------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COMM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ----
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 395 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 584 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 395 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 1+FEB++ 13:19 584 JOAPI add o
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99GENERATED OLEJU+1 1+FEB++ 13:19 JOAPI add o
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++88+++ TEST$API $MODNTRY LINKAGE=EXT,STACK=25+++,MSGDD=SYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++88+++ COPY $QIODS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++88+++ MAIN $FUNCSTG ,
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++88+++ GLOBALS DS +D
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++88+++ WDBLWORD DS D
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++27++++++88+++ MAINRSLT DS CL8
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++28++++++88+++ MAIN@QIO DS A ADDRESS OF
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++29++++++88+++ MAINMISS DS F MISMATCH C
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++3+++++++88+++ WINDEX DS F LAST FUNCT
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++31++++++88+++ WINDEX_ALENV EQU 1 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++32++++++88+++ WINDEX_ALSTG EQU 2 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++33++++++88+++ WINDEX_ALSYS EQU 3 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++34++++++88+++ WINDEX_ALSBS EQU 4 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++35++++++88+++ WINDEX_ALSIT EQU 5 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++36++++++88+++ WINDEX_ALELM EQU 6 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++37++++++88%++3 WINDEX_ALTYP EQU 7 . . .
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++38++++++88%++3 WINDEX_ALPGR EQU 8 . . .

2.6.4.5 Component Extract, Browse Record Layout

The following example shows the first 42 records found in the Browse Display format.
In this example, the records shown have been truncated for display purposes. To view a
complete record, invoke Endevor for OS/390 on-line and go to the Display Element
menu. Select the Browse Component Option against any element.

Chapter 2. API Function Calls 2-17

2.6 Extract Element and Component Data

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK COMPONENT BROWSE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM:NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79---------------------- COMPONENT LEVEL INFORMATION-------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COMM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ----
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 71 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 66 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 +9JAN++ 1+:41 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99+1.+4 OLEJU+1 21JAN++ 12:38 74 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99+1.+5 OLEJU+1 1+FEB++ 13:19 8+ JOAPI add
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++79-------------------------- ELEMENT INFORMATION ---------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++27+++++1+1 VV.LL DATE TIME SYSTEM SUBSYS ELEMENT TY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++28+++++1++%++5 +1.+3 1+FEB++ 13:19 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++29++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++3+++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++31++++++79------------------------ PROCESSOR INFORMATION ---------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++32++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++33+++++1+1 VV.LL DATE TIME SYSTEM SUBSYS ELEMENT TY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++34+++++1++++4 +1.+9 +5JUL97 17:34 LGNTLCL PROCESS GASM PR
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++35++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++36++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++37++++++78-------------------------- SYMBOL INFORMATION ----------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++38++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++39+++++135 DEFINED SYMBOL VALUE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++4++++++135++3 PROCESSOR AUTH +
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++41+++++135+++ PROCESSOR LET NOLET
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++42+++++135+++ PROCESSOR LINK YES

2.6.4.6 Component Extract, Change Record Layout

The following example shows the first 41 records found in the Change Display format.
In this example, the records shown have been truncated for display purposes. To view a
complete record, invoke Endevor for OS/390 on-line and go to the Display Element
menu. Select the Change Component Option against any element.

2-18 Endevor for OS/390 API Guide

 2.6 Extract Element and Component Data

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK COMPONENT CHANGES
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM:NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79---------------------- COMPONENT LEVEL INFORMATION-------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COMM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ----
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 71 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 66 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 +9JAN++ 1+:41 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99+1.+4 OLEJU+1 21JAN++ 12:38 74 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99+1.+5 OLEJU+1 1+FEB++ 13:19 8+ JOAPI add
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++79-------------------------- ELEMENT INFORMATION ----------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++27+++++1+1 VV.LL DATE TIME SYSTEM SUBSYS ELEMENT TY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++28+++++1++++5 +1.+3 1+FEB++ 13:19 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++29+++++1++++3-+5 +1.+2 +9JAN++ 1+:39 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++3+++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++31++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++32++++++79--------------------------- INPUT COMPONENTS ----------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++33++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++34++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++35++++++86STEP: ASSEM DD=SYSLIB VOL=NDVR+1 DSN=BST.INTMVSS1.MAC
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++36++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++37++++++96 MEMBER VV.LL DATE TIME SYSTEM SUBSYS E
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++38++++++95++5 ENHAEELM +1.++ 1+JAN++ 14:17 NDVRMVS BASE E
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++39++++++95++5 ENHALAGJ +1.++ 1+JAN++ 14:18 NDVRMVS BASE E
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++4+++++++95++5 ENHALAGR +1.++ 1+JAN++ 14:18 NDVRMVS BASE E
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++41++++++95++5 ENHALDSN +1.++ 1+JAN++ 14:18 NDVRMVS BASE E

2.6.4.7 Component Extract, History Record Layout

The History display lists all of the components and events related to an element. The
following example shows the first 41 records found in the History display format. In this
example, the records shown have been truncated for display purposes. To view a com-
plete record, invoke Endevor for OS/390 on-line and go to the Display Element menu.
Select the History Component Option against any element.

Chapter 2. API Function Calls 2-19

2.6 Extract Element and Component Data

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++1++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++2++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++3++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++4++++++79KK COMPONENT HISTORY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++5++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++6++++++79KK ENVIRONMENT: INT SYSTEM:NDVRMVS SUBSYS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++7++++++79KK ELEMENT: TEST$API TYPE: ASMPGM STAGE
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++8++++++79KK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1+++++++9++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++1+++++++79KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++11++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++12++++++79---------------------- COMPONENT LEVEL INFORMATION-------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++13++++++79
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++14++++++99VV.LL SYNC USER DATE TIME STMTS CCID COMM
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++15++++++99----- ---- -------- ------- ----- ----- ------------ ----
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++16++++++99+1.++ POCBR+1 3+APR99 16:++ 71 APU api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++17++++++99+1.+1 OLEJU+1 +9JAN++ +9:49 66 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++18++++++99+1.+2 OLEJU+1 +9JAN++ 1+:39 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++19++++++99+1.+3 OLEJU+1 +9JAN++ 1+:41 72 JOAPI keep
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++2+++++++99+1.+4 OLEJU+1 21JAN++ 12:38 74 JOAPI api
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++21++++++99+1.+5 OLEJU+1 1+FEB++ 13:19 8+ JOAPI add
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++22++++++99
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++23++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++24++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++25++++++79-------------------------- ELEMENT INFORMATION ----------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++26++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++27+++++1+1 VV.LL DATE TIME SYSTEM SUBSYS ELEMENT TY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++28+++++1++%++5 +1.+3 1+FEB++ 13:19 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++29+++++1++%++3-+5 +1.+2 +9JAN++ 1+:39 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++3++++++1++%++2-+3 +1.+2 +9JAN++ 1+:39 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++31+++++1++%++1-+2 +1.+1 +9JAN++ +9:49 NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++32+++++1++%+++-+1 +1.++ 3+APR99 16:++ NDVRMVS BASE TEST$API AS
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++33++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++34++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++35++++++79----------------------- PROCESSOR INFORMATION -----------
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++36++++++++
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++37+++++1+1 VV.LL DATE TIME SYSTEM SUBSYS ELEMENT TY
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++38+++++1++%++4 +1.+9 +5JUL97 17:34 LGNTLCL PROCESS GASMPR
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++39+++++1++%++3-+4 +1.+3 16AUG98 11:26 LGNTLCL PROCESS GASMPR
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++4++++++1++%+++-+3 +1.+9 +5JUL97 17:34 LGNTLCL PROCESS GASMPR
EELR+INT NDVRMVS BASE TEST$API ASMPGM 1++++++41++++++++

2-20 Endevor for OS/390 API Guide

 2.7 Generate Element Action

2.7 Generate Element Action

The generate element action API function call executes the generate processor for the
current level of an element.

Assembler: ENHAEGEN

COBOL: ECHAEGEN

2.7.1 AEGEN_RQ Request Structure Fields

Immediately following the header is the data area of the AEGEN_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AEGEN_RQ_ELM Character 10 Element name
AEGEN_RQ_ELM_THRU Character 10 Through element name
AEGEN_RQ_ENV Character 8 Environment name
AEGEN_RQ_SYSTEM Character 8 System name
AEGEN_RQ_SUBSYS Character 8 Subsystem name
AEGEN_RQ_TYPE Character 8 Type name
AEGEN_RQ_STG_ID Character 1 Stage id. Either stage id or stage
number must be specified, but not both.
AEGEN_RQ_STG_NUM Character 1 Stage number (1/2). Either stage id or
stage number must be specified, but not
both.
AEGEN_RQ_CCID Character 12 Change control id
AEGEN_RQ_COMM Character 40 Comment
AEGEN_RQ_COPYBACK Character 1 Copy back element (Y/N)
AEGEN_RQ_SEARCH Character 1 Search map (Y/N). Y is the default
AEGEN_RQ_OVESIGNO Character 1 Override signout (Y/N)

Chapter 2. API Function Calls 2-21

2.7 Generate Element Action

Field Length Description

AEGEN_RQ_PROGRO Character 8 Processor group name
AEGEN_RQ_RESERVE Character 3 ** Reserved field **
AEGEN_RQ_WCCID_ Character 1 Where CCID type (A/C/R). C is the
TYP default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AEGEN_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AEGEN_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

2-22 Endevor for OS/390 API Guide

 2.8 List Approver Group

2.8 List Approver Group

The list approver group API function call extracts information about the approver group
from the MCF that satisfies the criteria you define in the ALAGR_RQ request structure.
After the list approver group function call is processed, the first occurrence is always
placed in your defined response area, ALAGR_RS. This allows you to check the
response quickly if you are looking for a specific approver group. The API also writes
all responses generated by your request to an external data set if you specified a file
output DD name in the control structure.

Assembler: ENHALAGR

COBOL: ECHALAGR

2.8.1 ALAGR_RQ Request Structure Fields

Immediately following the header is the data area of the ALAGR_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALAGR_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy
the request.
ALAGR_RQ_ENV Character 8 Environment name. You cannot
specify a wildcard character in this
field.
ALAGR_RQ_AGRNAME Character 16 Approver group name. This field can
contain a wildcard character.

Searching: Map searching is not available for this request. The location value, Envi-
ronment, must be explicitly specified. The approver group name can contain a wildcard.

2.8.2 ALAGR_RS Response Structure Fields

Immediately following its header is the data area of the ALAGR_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALAGR_RS_SITE Character 1 Site id

Chapter 2. API Function Calls 2-23

2.8 List Approver Group

Field Length Description

ALAGR_RS_ENV Character 8 Environment name
ALAGR_RS_STG_NAME Character 8 Stage name
ALAGR_RS_STG_ID Character 1 Stage id
ALAGR_RS_STG_NUM Character 1 Stage number
ALAGR_RS_AGRNAME Character 16 Approver group name
ALAGR_RS_UPD_CNT Zoned Char 8 Record update count
ALAGR_RS_UPD_DATE Zoned Char 8 Update date YYYYMMDD
ALAGR_RS_UPD_TIME Zoned Char 8 Update time HHMMSSTH
ALAGR_RS_UPD_USER Character 8 Update user id
ALAGR_RS_FMID Zoned Char 5 Record created release id
ALAGR_RS_QUORM Zoned Char 8 Quorum count
ALAGR_RS_TITLE Character 50 Title
ALAGR_RS_AUSER 16 * Character 16 Approver user id's
8
ALAGR_RS_AUREQ 16 * Character 16 Approver Required flags - blank
1 or 'Y'

2-24 Endevor for OS/390 API Guide

 2.9 List Approver Group Junctions

2.9 List Approver Group Junctions

The list approver group junctions API function call extracts information about the
approver group from the MCF that satisfies the criteria you define in the ALAGJ_RQ
request structure. After the list approver group junctions function call is processed, the
first occurrence is always placed in your defined response area, ALAGJ_RS. This allows
you to check the response quickly if you are looking for a specific approver group junc-
tion. The API also writes all responses generated by your request to an external data set
if you specified a file output DD name in the control structure.

Assembler: ENHALAGJ

COBOL: ECHALAGJ

2.9.1 ALAGJ_RQ Request Structure Fields

Immediately following the header is the data area of the ALAGJ_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALAGJ_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALAGJ_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.
ALAGJ_RQ_SYSTEM Character 8 System name. This field may be
wildcarded by leaving it blank. If the
system name is specified, it must be
explicit.
ALAGJ_RQ_SUBSYS Character 8 Subsystem name. This field may be
wildcarded by leaving it blank. If the
subsystem name is specified, it must be
explicit.
ALAGJ_RQ_TYPE Character 8 Type name. This field may be
wildcarded by leaving it blank. If the
type name is specified, it must be
explicit.

Chapter 2. API Function Calls 2-25

2.9 List Approver Group Junctions

Field Length Description

ALAGJ_RQ_STG_NUM Character 1 Stage number. This field may be
wildcarded by leaving it blank. If the
stage number name is specified, it must
be explicit.

Searching: Map searching is not available for this request because these key values
can be stored in the MCF with the wild card values. The location value, Environment,
must be explicitly specified. The other keys (System, Subsystem, Type, and Stage) may
be individually wildcarded by leaving the field blank. Otherwise, the values specified for
these fields are treated as explicit key values.

2.9.2 ALAGJ_RS Response Structure Fields

Immediately following its header is the data area of the ALAGJ_RS response structure.
The information contained in the response structure is explained in the following tables.

Field Length Description

ALAGJ_RS_SITE Character 1 Site id
ALAGJ_RS_ENV Character 8 Environment name
ALAGJ_RS_SYSTEM Character 8 System name
ALAGJ_RS_SUBSYS Character 8 Subsystem name
ALAGJ_RS_TYPE Character 8 Type name
ALAGJ_RS_STG_NUM Character 1 Stage number
ALAGJ_RS_UPD_CNT Zoned Char 8 Record update count
ALAGJ_RS_UPD_DATE Zoned Char 8 Update date YYYYMMDD
ALAGJ_RS_UPD_TIME Zoned Char 8 Update time HHMMSSTH
ALAGJ_RS_UPD_USER Character 8 Update User id
ALAGJ_RS_FMID Zoned Char 5 Record created release id
ALAGJ_RS_JUN_TYPE Character 2 Junction type:
'ST' - Standard
'EM' - Emergency
ALAGJ_RS_AGNME Character 16 Approver Group name

2-26 Endevor for OS/390 API Guide

 2.10 List Data Set

2.10 List Data Set

The list data set API function call extracts information about data sets from the MCF that
satisfies the criteria you define in the ALDSN_RQ request structure. After the list data
set function call is processed, the first occurrence is always placed in your defined
response area, ALDSN_RS. This allows you to check the response quickly if you are
looking for a specific data set. The API also writes all responses generated by your
request to an external data set if you specified a file output DD name in the control
structure.

Assembler: ENHALDSN

COBOL: ECHALDSN

2.10.1 ALDSN_RQ Request Structure Fields

Immediately following the header is the data area of the ALDSN_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALDSN_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALDSN_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.
ALDSN_RQ_SYSTEM Character 8 System name. This field cannot contain a
wildcard character.
ALDSN_RQ_STG_ID Character 1 Stage id. This field cannot contain a
wildcard character.
ALDSN_RQ_DSNID Character 2 Data Set id. This field can contain a
wildcard character.

Searching: Map searching is not available for this request. All location values (Envi-
ronment, System, and Stage id) must be explicitly specified. The data set id value may
contain a wildcard character.

Chapter 2. API Function Calls 2-27

2.10 List Data Set

2.10.2 ALDSN_RS Response Structure Fields

Immediately following its header is the data area of the ALDSN_RS response structure.
The information contained in the response structure is explained in the following tables.

Field Length Description

ALDSN_RS_SITE Character 1 Site id
ALDSN_RS_ENV Character 8 Environment name
ALDSN_RS_SYSTEM Character 8 System name
ALDSN_RS_STG_NAME Character 8 Stage name
ALDSN_RS_STG_ID Character 1 Stage id
ALDSN_RS_STG_NUM Character 1 Stage number (1/2)
ALDSN_RS_DSNID Character 2 Data set record id
ALDSN_RS_DSNTY Character 2 Data set type: PO, PV, LB, EL, VK
ALDSN_RS_DSN Character 44 Data set name
ALDSN_RS_UPD_DATE Zoned Char 8 Record update date YYYYMMDD
ALDSN_RS_UPD_TIME Zoned Char 8 Record update time HHMMSSTH
ALDSN_RS_UPD_CNT Zoned Char 8 Record update count
ALDSN_RS_UPD_USER Character 8 Update user id

2-28 Endevor for OS/390 API Guide

 2.11 List Element

2.11 List Element

The list element API function call extracts information about elements from the MCF that
satisfies the criteria you define in the ALELM_RQ request structure. After the list
element function call is processed, the first occurrence is always placed in your defined
response area, ALELM_RS. This allows you to check the response quickly if you are
looking for a specific element. The API also writes all responses generated by your
request to an external data set if you specified a file output DD name in the control
structure.

Assembler: ENHALELM

COBOL: ECHALELM

2.11.1 ALELM_RQ Request Structure Fields

Immediately following the header is the data area of the ALELM_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALELM_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALELM_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy
the request.
ALELM_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the
map.
'B' for Search Between the two speci-
fied environments and stages.
'N' for No Search.
'E' for Search nExt specified
environment/stage then up the map.
'R' for Search the Range, between
and including the specified environ-
ments and stages.

Chapter 2. API Function Calls 2-29

2.11 List Element

Field Length Description

ALELM_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.
ALELM_RQ_SYSTEM Character 8 System name. This field can contain
a wildcard character.
ALELM_RQ_SUBSYS Character 8 Subsystem name. This field can
contain a wildcard character.
ALELM_RQ_TYPE Character 8 Type name. This field can contain a
wildcard character.
ALELM_RQ_ELM Character 10 Element name. This field can contain
a wildcard character.
ALELM_RQ_STG_ID Character 1 Stage id. This field can contain a
wildcard character.
ALELM_RQ_TOENV Character 8 To Environment name. If specified,
this field cannot contain a wildcard
character. Optional.
ALELM_RQ_TOSTG_ID Character 1 To Stage id. If specified, this field
cannot contain a wildcard character.
Optional.
ALELM_RQ_TOELM Character 10 To Element name. If specified, this
field can contain a wildcard.
Optional.

Searching: If you specify 'B', or 'R' for the ALELM_RQ_SEARCH search argument,
you must specify the To Environment in the ALELM_RQ_TOENV field and the To
Stage Id in the ALELM_RQ_TOSTG_ID field. You cannot use a wildcard. In addition,
these fields will also be ignored unless you use them with the 'B' or 'R' search fields.

If you specify the ALELM_RQ_TOELM field, To Element Name, the element name
must be greater than the ALELM_RQ_ELM field value, Element Name.

2.11.2 ALELM_RS Response Structure Fields

Immediately following its header is the data area of the ALELM_RS response structure.
The information contained in the response structure is explained in the following tables.

Field Length Description

ALELM_RS_SITE Character 1 Site id
ALELM_RS_ENV Character 8 Environment name
ALELM_RS_SYSTEM Character 8 System name

2-30 Endevor for OS/390 API Guide

 2.11 List Element

Field Length Description

ALELM_RS_SUBSYS Character 8 Subsystem name
ALELM_RS_ELEMENT Character 10 Element name
ALELM_RS_TYPE Character 8 Type name
ALELM_RS_STG_NAME Character 8 Stage name
ALELM_RS_STG_ID Character 1 Stage id
ALELM_RS_STG_NUM Character 1 Stage number (1/2)
ALELM_RS_STG_REL Zoned Char 4 Relative mapped stage number
ALELM_RS_PROCGRP Character 8 Processor group name
ALELM_RS_UPD_DATE Zoned Char 8 Record update date YYYYMMDD
ALELM_RS_UPD_TIME Zoned Char 8 Record update time HHMMSSTH
ALELM_RS_SIGNOUT Character 8 Signout user id
ALELM_RS_ELM_VV Zoned Char 2 Current element version number
ALELM_RS_ELM_LL Zoned Char 2 Current element level number
ALELM_RS_CMP_VV Character 2 Current component version number
ALELM_RS_CMP_LL Character 2 Current component level number

2.11.2.1 Information About the Last Action

Field Length Description

ALELM_RS_LMOD_NAME Character 8 Last element - modifying action
ALELM_RS_LACT_NAME Character 8 Last action
ALELM_RS_LACT_RC Character 5 Endevor return code
ALELM_RS_LACT_DATE Zoned Char 8 Date YYYYMMDD
ALELM_RS_LACT_TIME Zoned Char 8 Time HHMMSSTH
ALELM_RS_LACT_USER Character 8 User id
ALELM_RS_LACT_CCID Character 12 CCID
ALELM_RS_LACT_ Character 40 Comment
COMMENT

Chapter 2. API Function Calls 2-31

2.11 List Element

2.11.2.2 Information About the Element Base

Field Length Description

ALELM_RS_EBAS_NAME Character 10 Element base member name
ALELM_RS_EBAS_DATE Zoned Char 8 Element base date YYYYMMDD
ALELM_RS_EBAS_TIME Zoned Char 8 Element base time HHMMSSTH
ALELM_RS_EBAS_TOTL Zoned Char 5 Number of statements in base
ALELM_RS_EBAS_LVL Zoned Char 2 Base level number
ALELM_RS_EBAS_FLG1 Character 1 'Y', if Element base is com-
pressed
ALELM_RS_EBAS_USER Character 8 User id associated with base
ALELM_RS_EBAS_ Character 40 Comment associated with base
COMMENT

2.11.2.3 Information About the Element Delta (Last Level)

Field Length Description

ALELM_RS_EDLT_NAME Character 8 Element delta member name
ALELM_RS_EDLT_DATE Zoned Char 8 Element last level date
YYYYMMDD
ALELM_RS_EDLT_TIME Zoned Char 8 Element last level time
HHMMSSTH
ALELM_RS_EDLT_TOTL Zoned Char 5 Number of statements in last
level
ALELM_RS_EDLT_USER Character 8 User id associated with last level
ALELM_RS_EDLT_CCID Character 12 CCID associated with last level
ALELM_RS_EDLT_ Character 40 Comment associated with last
COMMENT level
ALELM_RS_EDLT_INS Zoned Char 5 Number of inserts in last level
ALELM_RS_EDLT_DEL Zoned Char 5 Number of deletes in last level
ALELM_RS_EDLT_FMT Character 1 'F' - Forward delta format
'R' - Reverse delta format

2-32 Endevor for OS/390 API Guide

 2.11 List Element

2.11.2.4 Information About the Component List Base

Field Length Description

ALELM_RS_XBAS_NAME Character 8 Component base member name
ALELM_RS_XBAS_DATE Zoned Char 8 Component base date
YYYYMMDD
ALELM_RS_XBAS_TIME Zoned Char 8 Component base time
HHMMSSTH
ALELM_RS_XBAS_TOTL Zoned Char 8 Number of statements in base
ALELM_RS_XBAS_LVL Zoned Char 2 Base level number

2.11.2.5 Information About the Component List Delta

Field Length Description

ALELM_RS_XDLT_NAME Character 8 Component delta member name
ALELM_RS_XDLT_DATE Zoned Char 8 Component last level date
YYYYMMDD
ALELM_RS_XDLT_TIME Zoned Char 8 Component last level time
HHMMSSTH
ALELM_RS_XDLT_TOTL Zoned Char 8 Number of statements in last level
ALELM_RS_XDLT_INS Zoned Char 8 Number of inserts in last level
ALELM_RS_XDLT_DEL Zoned Char 8 Number of deletes in last level
ALELM_RS_XDLT_FMT Character 1 'F' - Forward delta format
'R' - Reverse delta format
ALELM_RS_XDLT_MON Character 1 'M' - Component list built by
monitor
ALELM_RS_XDLT_CPY Character 1 'C' - Component list copied or
restored
ALELM_RS_XDLT_DLTA Character 1 'D' - Component list base stored in
the delta library

2.11.2.6 Information About the Last Element Move

Field Length Description

ALELM_RS_MOV_DATE Zoned Char 8 Element Move date YYYYMMDD
ALELM_RS_MOV_TIME Zoned Char 8 Element Move time HHMMSSTH

Chapter 2. API Function Calls 2-33

2.11 List Element

Field Length Description

ALELM_RS_MOV_USER Character 8 User id associated with the move

2.11.2.7 Information About the Last Add or Update Data Set

Field Length Description

ALELM_RS_FR_DSN Character 44 Add/Update from data set name
ALELM_RS_FR_MBR Character 10 Add/Update from member name

2.11.2.8 Information About the Element Processor Execution

Field Length Description

ALELM_RS_PROC_FLG1 Character 1 '0' - No processor executed
'1' - Last processor was Generate
'2' - Last processor was Move
'3' - Last processor was Delete
'4' - Last processor was unknown
ALELM_RS_PROC_FLG2 Zoned Char 8 'F' - Last processor failed
ALELM_RS_PROC_DATE Zoned Char 8 Element last processor date
YYYYMMDD
ALELM_RS_PROC_TIME Zoned Char 8 Element last processor time
HHMMSSTH
ALELM_RS_GEN_DATE Zoned Char 8 Element last generate date
YYYYMMDD
ALELM_RS_GEN_TIME Zoned Char 8 Element last generate time
HHMMSSTH
ALELM_RS_GEN_USER Character 8 User id associated with last gen-
erate
ALELM_RS_GEN_CCID Character 12 CCID associated with last generate
ALELM_RS_GEN_ Character 40 Comment associated with last gen-
COMMENT erate
ALELM_RS_PROC_FLG Character 8 '*FAILED*' - if last processed
failed execution
ALELM_RS_LASTPROC Character 8 Name of the last processor exe-
cuted
ALELM_RS_PROC_RC Character 5 Processor return code

2-34 Endevor for OS/390 API Guide

 2.11 List Element

2.11.2.9 Information About the Last Element Retrieve

Field Length Description

ALELM_RS_RET_DATE Zoned Char 8 Last Retrieve date YYYYMMDD
ALELM_RS_RET_TIME Zoned Char 8 Last Retrieve time HHMMSSTH
ALELM_RS_RET_USER Character 8 User id associated with last
retrieve
ALELM_RS_RET_CCID Character 12 CCID associated with last retrieve
ALELM_RS_RET_COMM Character 40 Comment associated with last
retrieve
ALELM_RS_RET_DSN Character 44 Retrieve-To data set name
ALELM_RS_RET_MBR Character 10 Retrieve-To member name

2.11.2.10 Information About the Package Last Executed Against the Element
Source

Field Length Description

ALELM_RS_SPKG_DATE Zoned Char 8 Date YYYYMMDD
ALELM_RS_SPKG_TIME Zoned Char 8 Time HHMMSSTH
ALELM_RS_SPKG_ID Character 16 Package id

2.11.2.11 Information About the Package Last Executed Against the Element
Outputs

Field Length Description

ALELM_RS_OPKG_DATE Zoned Char 8 Date YYYYMMDD
ALELM_RS_OPKG_TIME Zoned Char 8 Time HHMMSSTH
ALELM_RS_OPKG_ID Character 16 Package id

2.11.2.12 Information About the Last "FROM" Endevor location

Field Length Description

ALELM_RS_FROM_SITE Character 1 Site id
ALELM_RS_FROM_ENV Character 8 Environment name
ALELM_RS_FROM_SYS Character 8 System name
ALELM_RS_FROM_SBS Character 8 Subsystem name

Chapter 2. API Function Calls 2-35

2.11 List Element

Field Length Description

ALELM_RS_FROM_ELM Character 10 Element name
ALELM_RS_FROM_TYPE Character 8 Type name
ALELM_RS_FROM_STG# Character 1 Stage number
ALELM_RS_FROM_FACT Character 8 Action that updated "From" location
ALELM_RS_FROM_VV Character 2 Version number
ALELM_RS_FROM_LL Character 2 Level number

2.11.2.13 Other Fields

Field Length Description

ALELM_RS_FMID Zoned Char 5 Record created release id

2-36 Endevor for OS/390 API Guide

 2.12 List Environment

2.12 List Environment

The list environment API function call extracts information about environments in
Endevor that satisfies the criteria you define in the ALENV_RQ request structure. After
the list environment function call is processed, the first occurrence is always placed in
your defined ALENV_RS response area. This allows you to check the response quickly
if you are looking for a specific environment. The API also writes all responses gener-
ated by your request to an external data set if you specified a file output DD name in the
control structure.

Assembler: ENHALENV

COBOL: ECHALENV

2.12.1 ALENV_RQ Request Structure Fields

Immediately following the header is the data area of the ALENV_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALENV_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALENV_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALENV_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the map.
'B' for Search Between the two specified
environments.
'N' for No Search.
'E' for Search nExt specified environ-
ment then up the map.
'R' for Search the Range, between and
including the specified environments.
ALENV_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.

Chapter 2. API Function Calls 2-37

2.12 List Environment

Field Length Description

ALENV_RQ_TOENV Character 8 To environment name. If specified, this
field cannot contain a wildcard character.
Optional.

Searching: If you specify:

'E', 'B', or 'R' for the ALENV_RQ_SEARCH search argument, you cannot use a
wildcard in the Environment name.

'B', or 'R' for the ALENV_RQ_SEARCH search argument, you must specify the To
Environment in the ALENV_RQ_TOENV field. You cannot use a wildcard.

The To Environment in the ALENV_RQ_TOENV field, it will be ignored unless you
also specify the 'B' or 'R' search option.

2.12.2 ALENV_RS Response Structure Fields

Immediately following its header is the data area of the ALENV_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALENV_RS_SITE Character 1 Site id
ALENV_RS_ENV Character 8 Environment id
ALENV_RS_TITLE Character 40 Description
ALENV_RS_USEC Character 8 User security name table
ALENV_RS_RSEC Character 8 Resource security name table
ALENV_RS_SMFSEC Character 1 SMF Recording - Security. Value Y for
Yes or N for No.
ALENV_RS_SMFACT Character 1 SMF Recording - Actions. Value Y for
Yes or N for No.
ALENV_RS_SMFENV Character 1 SMF Recording - Environment. Value Y
for Yes or N for No.
ALENV_RS_DBAVL Character 1 DB Bridge Available. Value Y for Yes
or N for No.
ALENV_RS_DBACT Character 1 DB Bridge Active. Value Y for Yes or N
for No.
ALENV_RS_DBOPT1 Character 1 DB Bridge Option 1. Value Y for Yes or
N for No.
ALENV_RS_DBOPT2 Character 1 DB Bridge Option 2. Value Y for Yes or
N for No.

2-38 Endevor for OS/390 API Guide

 2.12 List Environment

Field Length Description

ALENV_RS_DBOPT3 Character 1 DB Bridge Option 3. Value Y for Yes or
N for No.
ALENV_RS_DBOPT4 Character 1 DB Bridge Option 4. Value Y for Yes or
N for No.
ALENV_RS_CSPDS Character 44 CSP Footprint data set name.

Chapter 2. API Function Calls 2-39

2.13 List Processor Group

2.13 List Processor Group

The list processor group API function call extracts information from the MCF that satis-
fies the criteria you define in the ALPGR_RQ request structure about the processor
group. It will also extract any symbolic overrides that have been defined for any of the
group's processors.

A record is produced for each processor within a group. Processor group information that
relates to the whole group is replicated on each processor record. Also, if overrides exist
for any processor, the whole record is replicated with an override value appended to the
record. For example, if a group has two processors defined, and the first processor has
two overrides while the second only has one, three records are produced:

The first record contains the group's information. The first processor information is
followed by the first symbolic override data.

The second record contains the same group and processor information followed by
the second override data.

The third record contains the same group information, the second processor informa-
tion, followed by the symbolic override data pertaining to the second processor.

After the list processor group function call is processed, the first occurrence is always
placed in your defined response area, ALPGR_RS. This allows you to check the
response quickly if you are looking for a specific processor group. The API also writes
all responses generated by your request to an external data set if you specified a file
output DD name in the control structure.

Assembler: ENHALPGR

COBOL: ECHALPGR

2.13.1 ALPGR_RQ Request Structure Fields

Immediately following the header is the data area of the ALPGR_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALPGR_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALPGR_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.

2-40 Endevor for OS/390 API Guide

 2.13 List Processor Group

Field Length Description

ALPGR_RQ_SYSTEM Character 8 System name. This field cannot contain a
wildcard character.
ALPGR_RQ_TYPE Character 8 Type name. This field cannot contain a
wildcard character.
ALPGR_RQ_STG_ID Character 1 Stage id. This field cannot contain a
wildcard character.
ALPGR_RQ_PGRP Character 8 Processor Group Name. This field can
contain a wildcard character.

Searching: Map searching is not available for this request. All location values (Envi-
ronment, System, Type, and Stage id) must be explicitly specified. The processor group
name can contain a wildcard.

2.13.2 ALPGR_RS Response Structure Fields

Immediately following its header is the data area of the ALPGR_RS response structure.
The information contained in the response structure is explained in the following tables.

Field Length Description

ALPGR_RS_SITE Character 1 Site id
ALPGR_RS_ENV Character 8 Environment name
ALPGR_RS_SYSTEM Character 8 System name
ALPGR_RS_TYPE Character 8 Type name
ALPGR_RS_STG_NAME Character 8 Stage name
ALPGR_RS_STG_ID Character 1 Stage id
ALPGR_RS_STG_NUM Character 1 Stage number (1/2)
ALPGR_RS_PGRP Character 8 Processor group name
ALPGR_RS_PROTY Character 4 Processor type:
'DEL ' - for delete processor
'GEN ' - for generate processor
'MOVE' - for move processor
ALPGR_RS_SYM# Zoned Char 4 Symbolic override number. If no
symbolic overrides exist for this
ALPGR-RS-SYMNUM
processor, this value will be set to
(COBOL)
zero.
ALPGR_RS_UPD_DATE Zoned Char 8 Record update date YYYYMMDD

Chapter 2. API Function Calls 2-41

2.13 List Processor Group

Field Length Description

ALPGR_RS_UPD_TIME Zoned Char 8 Record update time HHMMSSTH
ALPGR_RS_UPD_USER Character 8 Update User id
ALPGR_RS_DESC Character 50 Processor group description
ALPGR_RS_NEXT_PGR Character 8 Next pathed processor group
ALPGR_RS_PMOVE Character 1 Processor to use on Move actions:
'G' - for Generate
'M' - for Move
ALPGR_RS_PXFER Character 1 Processor to use on Transfer
actions:
'G' - for Generate
'M' - for Move
ALPGR_RS_PRONME Character 8 Processor name
ALPGR_RS_PROFG Character 1 Foreground Processing flag. Value
Y for Yes and N for No.
ALPGR_RS_SYM_LEN Zoned Char 2 Override symbol length
ALPGR_RS_SYM Character 8 Override symbol
ALPGR_RS_SVAL_LEN Zoned Char 4 Override symbol value length
ALPGR_RS_SVAL Character 256 Override symbol value

2-42 Endevor for OS/390 API Guide

 2.14 List Site

2.14 List Site

The list site API function call extracts information about sites. After the list site function
call is processed, the information is placed in your defined response area, ALSIT_RS.
This allows you to check the response quickly if you are looking for specific site infor-
mation. The API also writes this data to an external data set if you specified a file output
DD name in the control structure.

Assembler: ENHALSIT

COBOL: ECHALSIT

2.14.1 ALSIT_RQ Request Structure Fields

The ALSIT_RQ request structure defines your List Site fields, which in this case is only
the Site header. No additional data can be specified.

2.14.2 ALSIT_RS Response Structure Fields

Immediately following the header is the data area of the ALSIT_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALSIT_RS_NDVRREL Character 6 Endevor release identifier.
ALSIT_RS_SITEID Character 1 Site id
ALSIT_RS_SITENAME Character 50 Site name
ALSIT_RS_DFLTDATE Character 8 C1DEFLTS assembly date
ALSIT_RS_DFLTTIME Character 8 C1DEFLTS assembly time
ALSIT_RS_APPRREQD Character 1 Approvals required
ALSIT_RS_EXITAUTH Character 8 Authorized library for exits
ALSIT_RS_ELNKXTBL Character 8 ELink data stream translate table
ALSIT_RS_LINESPP Zoned Char 2 Lines per page (reports and logs)
ALSIT_RS_MACLIB Character 44 Endevor installation macro library
ALSIT_RS_PKGCSEC Character 1 Perform Security Check at Cast
flag. Value Y for Yes and N for
No.

Chapter 2. API Function Calls 2-43

2.14 List Site

Field Length Description

ALSIT_RS_PKGCVAL Character 1 Component Validation flag
'O' - for Optional
'Y' - for required
ALSIT_RS_PKGTSO Character 1 Package Execution Valid in Fore-
ground flag. Value Y for Yes and N
for No.
ALSIT_RS_MFMTCCID Character 1 Mixed Case for CCID flag. Value Y
for Yes and N for No.
ALSIT_RS_MFMTCMNT Character 1 Mixed Case for Comment flag.
Value Y for Yes and N for No.
ALSIT_RS_MFMTDESC Character 1 Mixed Case for Description flag.
Value Y for Yes and N for No.
ALSIT_RS_PKGDSN Character 44 Endevor Package data set name
ALSIT_RS_CCIDVAL Character 44 Endevor CCID Validation table
ALSIT_RS_MODHLI Character 8 High Level Qualifier for
DISP=MOD temporary data set
names on processor executions.
ALSIT_RS_ACCSTABL Character 8 ESI access security table
ALSIT_RS_ACMOPT Character 1 Endevor ACM Option Available
flag. Value Y for Yes and N for
No.
ALSIT_RS_CSPOPT Character 1 Endevor CSP Option Available flag.
Value Y for Yes and N for No.
ALSIT_RS_DB2OPT Character 1 Endevor DB2 Option Available
flag. Value Y for Yes and N for
No.
ALSIT_RS_ELKOPT Character 1 Endevor ELink Option Available
flag. Value Y for Yes and N for
No.
ALSIT_RS_ESIOPT Character 1 Endevor ESI Option Available flag.
Value Y for Yes and N for No.
ALSIT_RS_INFOPT Character 1 Endevor INFOMAN Option Avail-
able flag. Value Y for Yes and N
for No.
ALSIT_RS_JRNLGRP Character 14 Point-in-time recovery journal
group.

2-44 Endevor for OS/390 API Guide

 2.14 List Site

Field Length Description

ALSIT_RS_LPVOPT Character 1 Endevor LIB/PNV Option Available
flag. Value Y for Yes and N for
No.
ALSIT_RS_PDMOPT Character 1 Endevor PDM Option Available
flag. Value Y for Yes and N for
No.
ALSIT_RS_PRCOPT Character 1 Endevor Processor Option Avail-
able. Value Y for Yes and N for
No.
ALSIT_RS_QEDOPT Character 1 Endevor Quick Edit Option Avail-
able flag. Value Y for Yes and N
for No.
ALSIT_RS_SOFETCH Character 1 Signout Source on Fetch (Retrieve
Action) Option flag. Value Y for
Yes and N for No.
ALSIT_RS_GNIPSOUT Character 1 Signout on Generate in Place
Action flag. Value Y for Yes and N
for No.
ALSIT_RS_SMFREC# Zoned Char 3 SMF record number
ALSIT-RS-SMFRECNUM
(COBOL)
ALSIT_RS_RACFUID Character 8 Endevor alternate RACF userid
ALSIT_RS_RACFGRP Character 8 Endevor alternate RACF group
ALSIT_RS_RACFPWD Character 8 Endevor alternate RACF password
ALSIT_RS_LIBENV Character 2 CA-Panvalet/CA-Librarian (PV/LB)
environment
ALSIT_RS_LIBPGM Character 8 CA-Librarian interface program
name
ALSIT_RS_RJCLROOT Character 4 Package ship remote JCL root
model member
ALSIT_RS_SPFEDIT Character 8 Reserve QNAME for non-load
libraries
ALSIT_RS_SYSIEWLP Character 8 Reserve QNAME for load libraries
ALSIT_RS_TSOE Character 1 TSO-E Installed flag. Value Y for
Yes and N for No.
ALSIT_RS_WRKUNIT Character 8 Esoteric non-vio work unit name.
ALSIT_RS_WRKVOL Character 6 Work unit VOLSER

Chapter 2. API Function Calls 2-45

2.14 List Site

Field Length Description

ALSIT_RS_BATCHID Zoned Char 1 Batch Id flag:
'0' - Userid taken from jobname
'1' - Userid taken from user= param-
eter
'2' - Userid taken from user= param-
eter, but if blank, take from
jobname
ALSIT_RS_UIDLOCO Zoned Char 1 Userid offset in jobcard
ALSIT_RS_UIDLOCL Zoned Char 1 Userid length in jobname
ALSIT_RS_VIOUNIT Character 8 Esoteric VIO unit name

2-46 Endevor for OS/390 API Guide

 2.15 List Stage

2.15 List Stage

The list stage API function call extracts information about stages in Endevor that satisfies
the criteria you define in the ALSTG_RQ request structure. After the list stage function
call is processed, the first occurrence is always placed in your defined response area,
ALSTG_RS. This allows you to check the response quickly if you are looking for a
specific stage. The API also writes all responses generated by your request to an external
data set if you specified a file output DD name in the control structure.

Assembler: ENHALSTG

COBOL: ECHALSTG

2.15.1 ALSTG_RQ Request Structure Fields

Immediately following the header is the data area of the ALSTG_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALSTG_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALSTG_RQ_RETURN Character 1 'F' for return only the first record that sat-
isfies the request.
A' for return All
ALSTG_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the map.
'B' for Search Between the two specified
environments and stages.
'N' for No Search.
'E' for Search nExt specified
environment/stage then up the map.
'R' for Search the Range, between and
including the specified environments and
stages.
ALSTG_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.

Chapter 2. API Function Calls 2-47

2.15 List Stage

Field Length Description

ALSTG_RQ_TOENV Character 8 To Environment name. If specified, this
field cannot contain a wildcard character.
Optional.
ALSTG_RQ_STG Character 1 Stage id. This field can be a wildcard
character.
ALSTG_RQ_TOSTG Character 1 To Stage id. If specified, this field cannot
contain a wildcard character. Optional.

Searching: If you specify 'B', or 'R' for the ALSTG_RQ_SEARCH search argument,
you must specify the To Environment in the ALSTG_RQ_TOENV field and the To Stage
Id in the ALSTG_RQ_TOSTG field. You cannot use a wildcard. In addition, these
fields will be ignored unless the 'B' or 'R' search field is also specified.

2.15.2 ALSTG_RS Response Structure Fields

Immediately following its header is the data area of the ALSTG_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALSTG_RS_SITE Character 1 Site id
ALSTG_RS_ENV Character 8 Environment name
ALSTG_RS_STG_NAME Character 8 Stage name
ALSTG_RS_STG_ID Character 1 Stage id
ALSTG_RS_STG_NUM Character 1 Stage number
ALSTG_RS_TITLE Character 20 Title.
ALSTG_RS_DSN Character 44 MCF data set name

2-48 Endevor for OS/390 API Guide

 2.16 List Subsystem

2.16 List Subsystem

The list subsystem API function call extracts information about subsystems from the
MCF that satisfies the criteria you define in the ALSBS_RQ request structure. After the
list subsystem function call is processed, the first occurrence is always placed in your
defined response area, ALSBS_RS. This allows you to check the response quickly if you
are looking for a specific subsystem. The API also writes all responses generated by
your request to an external data set if you specified a file output DD name in the control
structure.

Assembler: ENHALSBS

COBOL: ECHALSBS

2.16.1 ALSBS_RQ Request Structure Fields

Immediately following the header is the data area of the ALSBS_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALSBS_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALSBS_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALSBS_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the map.
'B' for Search Between the two specified
environments and stages.
'N' for No Search.
'E' for Search nExt specified
environment/stage then up the map.
'R' for Search the Range, between and
including the specified environments and
stages.

Chapter 2. API Function Calls 2-49

2.16 List Subsystem

Field Length Description

ALSBS_RQ_ENV Character 8 Environment name. This field cannot
contain a wildcard character.
ALSBS_RQ_TOENV Character 8 To Environment name. If specified, this
field cannot contain a wildcard character.
Optional.
ALSBS_RQ_STG_ID Character 1 Stage id. This field can contain a
wildcard character.
ALSBS_RQ_TOSTG_ID Character 1 To Stage id. If specified, this field
cannot contain a wildcard character.
Optional.
ALSBS_RQ_SYSTEM Character 8 System name. This field can contain a
wildcard character.
ALSBS_RQ_SUBSYS Character 8 Subsystem name. This field can contain
a wildcard character.

Searching: If you specify 'B', or 'R' for the ALSBS_RQ_SEARCH search argument,
you must specify the To Environment in the ALSBS_RQ_TOENV field and the To Stage
Id in the ALSBS_RQ_TOSTG_ID field. You cannot use a wildcard. In addition, these
fields will be ignored unless you also specify the 'B' or 'R' search field.

2.16.2 ALSBS_RS Response Structure Fields

Immediately following its header is the data area of the ALSBS_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALSBS_RS_SITE Character 1 Site id
ALSBS_RS_ENV Character 8 Environment name
ALSBS_RS_SYSTEM Character 8 System name
ALSBS_RS_SUBSYS Character 8 Subsystem name
ALSBS_RS_STG_NAME Character 8 Stage name
ALSBS_RS_STG_ID Character 1 Stage id
ALSBS_RS_STG_REL Zoned Char 4 Relative mapped stage number
ALSBS_RS_UPD_CNT Zoned Char 8 Record update count
ALSBS_RS_UPD_DATE Zoned Char 8 Update date YYYYMMDD
ALSBS_RS_UPD_TIME Zoned Char 8 Update time HHMMSSTH
ALSBS_RS_UPD_USER Character 8 Update user id

2-50 Endevor for OS/390 API Guide

 2.16 List Subsystem

Field Length Description

ALSBS_RS_TITLE Character 50 Subsystem title
ALSBS_RS_NXT_SBS Character 8 Next subsystem name in path
ALSBS_RS_FMID Zoned Char 5 Record created release id

Chapter 2. API Function Calls 2-51

2.17 List System

2.17 List System

The list system API function call extracts information about systems from MCF files that
satisfies the criteria you define in the ALSYS_RQ request structure. After the list system
function call is processed, the first occurrence is always placed in your defined response
area, ALSYS_RS. This allows you to check the response quickly if you are looking for a
specific system. The API also writes all responses generated by your request to an
external data set if you specified a file output DD name in the control structure.

Assembler: ENHALSYS

COBOL: ECHALSYS

2.17.1 ALSYS_RQ Request Structure Fields

Immediately following the header is the data area of the ALSYS_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALSYS_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALSYS_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALSYS_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the map.
'B' for Search Between the two speci-
fied environments and stages.
'N' for No Search.
'E' for Search nExt specified
environment/stage then up the map.
'R' for Search the Range, between and
including the specified environments
and stages.
ALSYS_RQ_ENV Character 8 Environment name. You cannot use a
wildcard character in this field.

2-52 Endevor for OS/390 API Guide

 2.17 List System

Field Length Description

ALSYS_RQ_TOENV Character 8 To Environment name. If specified, it
cannot contain a wildcard character.
Optional.
ALSYS_RQ_STG_ID Character 1 Stage id. You can use a wildcard char-
acter in this field.
ALSYS_RQ_TOSTG_ID Character 1 To Stage id. If specified, it cannot
contain a wildcard character. Optional.
ALSYS_RQ_SYSTEM Character 8 System name. You can use a wildcard
character in this field.

Searching: If you specify 'B', or 'R' for the ALSYS_RQ_SEARCH search argument,
you must specify the To Environment in the ALSYS_RQ_TOENV field and the To Stage
Id in the ALSYS_RQ_TOSTG_ID field. You cannot use a wildcard. In addition, these
fields will be ignored unless you also specify the 'B' or 'R' search field.

2.17.2 ALSYS_RS Response Structure Fields

Immediately following its header is the data area of the ALSYS_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALSYS_RS_SITE Character 1 Site id
ALSYS_RS_ENV Character 8 Environment name
ALSYS_RS_SYSTEM Character 8 System name
ALSYS_RS_STG_NAME Character 8 Stage name
ALSYS_RS_STG_ID Character 1 Stage id
ALSYS_RS_STG_REL Zoned Char 4 Relative mapped stage number
ALSYS_RS_UPD_CNT Zoned Char 8 Record update count
ALSYS_RS_UPD_DATE Zoned Char 8 Update date YYYYMMDD
ALSYS_RS_UPD_TIME Zoned Char 8 Update time HHMMSSTH
ALSYS_RS_UPD_USER Character 8 Update user id
ALSYS_RS_TITLE Character 50 System title
ALSYS_RS_NXT_SYS Character 8 Next system name in path
ALSYS_RS_LOADLIB Character 44 Processor load library
ALSYS_RS_LISTING Character 44 Processor listing library

Chapter 2. API Function Calls 2-53

2.17 List System

Field Length Description

ALSYS_RS_COMMENT Character 1 Comment Required flag. Value is Y
for Yes or No for No.
ALSYS_RS_CCID Character 1 CCID Required flag. Value is Y for
Yes or No for No.
ALSYS_RS_SISO1 Character 1 Signout Required flag. Value is Y for
Yes or No for No.
ALSYS_RS_SISO2 Character 1 Validate Retrieve Dataset flag. Value
is Y for Yes or No for No.
ALSYS_RS_CSPASSOC Character 1 CSP Associates
ALSYS_RS_JUMP Character 1 Jump Option Required flag. Value is
Y for Yes or No for No.
ALSYS_RS_BAK_DATE Zoned Char 8 Backup date YYYYMMDD
ALSYS_RS_BAK_TIME Zoned Char 8 Backup Time HHMMSSTH
ALSYS_RS_FMID Zoned Char 5 Record created release id

2-54 Endevor for OS/390 API Guide

 2.18 List Type

2.18 List Type

The list type API function call extracts information about types from the MCF that satis-
fies the criteria you define in the ALTYP_RQ request structure. After the list type func-
tion call is processed, the first occurrence is always placed in your defined ALTYP_RS
response area. This allows you to check the response quickly if you are looking for a
specific type. The API also writes all responses generated by your request to an external
data set if you specified a file output DD name in the control structure.

Assembler: ENHALTYP

COBOL: ECHALTYP

2.18.1 ALTYP_RQ Request Structure Fields

Immediately following the header is the data area of the ALTYP_RQ request structure.
The request structure is where you set your selection criteria. All request selection fields
are explained in the following table.

Field Length Description

ALTYP_RQ_PATH Character 1 Mapping path:
'L' for Logical
'P' for Physical
ALTYP_RQ_RETURN Character 1 'F' for return only the first record that
satisfies the request.
'A' for return all records that satisfy the
request.
ALTYP_RQ_SEARCH Character 1 Mapping argument:
'A' for Search All the way up the map.
'B' for Search Between the two speci-
fied environments and stages.
'N' for No Search
'E' for Search nExt specified
environment/stage then up the map.
'R' for Search the Range, between and
including the specified environments
and stages.
ALTYP_RQ_ENV Character 8 Environment name. You cannot use a
wildcard character in this field.

Chapter 2. API Function Calls 2-55

2.18 List Type

Field Length Description

ALTYP_RQ_TOENV Character 8 To Environment name. If specified, this
field cannot contain a wildcard char-
acter. Optional.
ALTYP_RQ_STG_ID Character 1 Stage id. This field can contain a
wildcard character.
ALTYP_RQ_TOSTG_ID Character 1 To Stage id. If specified, this field
cannot contain a wildcard character.
Optional.
ALTYP_RQ_SYSTEM Character 8 System name. This field can contain a
wildcard character.
ALTYP_RQ_TYPE Character 8 Type name. This field can contain a
wildcard character.

Searching: If you specify 'B', or 'R' for the ALTYP_RQ_SEARCH search argument,
you must specify the To Environment in the ALTYP_RQ_TOENV field and the To Stage
Id in the ALTYP_RQ_TOSTG_ID field. You cannot use a wildcard. In addition, these
fields will be ignored unless you also specify the 'B' or 'R' search field.

2.18.2 ALTYP_RS Response Structure Fields

Immediately following its header is the data area of the ALTYP_RS response structure.
The information contained in the response structure is explained in the following table.

Field Length Description

ALTYP_RS_SITE Character 1 Site name
ALTYP_RS_ENV Character 8 Environment name
ALTYP_RS_SYSTEM Character 8 System name
ALTYP_RS_TYPE Character 8 Type name
ALTYP_RS_TYPENBR Character 2 Type number id
ALTYP_RS_STG_NAME Character 8 Stage name
ALTYP_RS_STG_ID Character 1 Stage id
ALTYP_RS_STG_NUM Character 1 Stage number
ALTYP_RS_STG_REL Zoned Char 4 Relative mapped stage number
ALTYP_RS_UPD_CNT Zoned Char 8 Record update count
ALTYP_RS_UPD_DATE Zoned Char 8 Update date YYYYMMDD
ALTYP_RS_UPD_TIME Zoned Char 8 Update time HHMMSSTH

2-56 Endevor for OS/390 API Guide

 2.18 List Type

Field Length Description

ALTYP_RS_UPD_USER Character 8 Update user id
ALTYP_RS_FMID Zoned Char 5 Record created release id
ALTYP_RS_NXT_TYP Character 8 Next type name in path
ALTYP_RS_DESC Character 50 Type description
ALTYP_RS_DPGRPNME Character 8 Default processor group name
ALTYP_RS_FILEEXT Character 8 PC extension
ALTYP_RS_HOOP Character 1 Home OPSYS: M-OS/390
W-Workstation
ALTYP_RS_EXTLANG Character 8 Language
ALTYP_RS_INTLANG Character 8 PV/LB Language
ALTYP_RS_REPCT Character 2 Regression percent
ALTYP_RS_RESEV Character 1 Regression severity
ALTYP_RS_SLEN Character 5 Source length
ALTYP_RS_CMPFR Character 5 Compare from
ALTYP_RS_CMPTO Character 5 Compare to
ALTYP_RS_AUCON Character 1 Auto Consolidate flag. Value Y for
Yes and N for No.
ALTYP_RS_AULTC Character 3 Consolidate level
ALTYP_RS_AUCLE Character 3 Auto consolidate level
ALTYP_RS_CAUCO Character 1 Component Auto Consolidate flag.
Value Y for Yes and N for No.
ALTYP_RS_CULTC Character 3 Component consolidate level
ALTYP_RS_CAUCL Character 3 Component auto consolidate level
ALTYP_RS_SOEXI Character 1 Expand include in source output
library. Value Y for Yes and N for
No.
ALTYP_RS_DELTY Character 1 F - Forward element delta
R - Reverse element delta
ALTYP_RS_CDELTY Character 1 F - Forward component delta
R - Reverse component delta
ALTYP_RS_CMPBA Character 1 Compress Base flag. Value Y for
Yes and N for No.

Chapter 2. API Function Calls 2-57

2.18 List Type

Field Length Description

ALTYP_RS_NNCR Character 1 Not encrypted element name. Value
Y for Yes and N for No.
ALTYP_RS_ODSTYP Character 2 Source output data set type:
PO / PV / LB
ALTYP_RS_ODSNME Character 44 Source output data set name
ALTYP_RS_IDSTYP Character 2 Include data set type:
PO / PV / LB
ALTYP_RS_IDSNME Character 44 Include data set name
ALTYP_RS_BDSTYP Character 2 Base data set type:
PO / PV / LB / EL / VK
ALTYP_RS_BDSNME Character 44 Base data set name
ALTYP_RS_UDSTYP Character 2 Update data set type:
PO / PV / LB / EL / VK
ALTYP_RS_UDSNME Character 44 Update data set name

2-58 Endevor for OS/390 API Guide

 2.19 Move Element Action

2.19 Move Element Action

The move element action API function call moves elements between inventory locations
along a map.

Assembler: ENHAEMOV

COBOL: ECHAEMOV

2.19.1 AEMOV_RQ Request Structure Fields

Immediately following the header is the data area of the AEMOV_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AEMOV_RQ_ELM Character 10 Element name
AEMOV_RQ_ELM_ Character 10 Through element name
THRU
AEMOV_RQ_ENV Character 8 Environment name
AEMOV_RQ_SYSTEM Character 8 System name
AEMOV_RQ_SUBSYS Character 8 Subsystem name
AEMOV_RQ_TYPE Character 8 Type name
AEMOV_RQ_STG_ID Character 1 Stage id. Either stage id or stage
number must be specified, but not both.
AEMOV_RQ_STG_NUM Character 1 Stage number (1/2). Either stage id or
stage number must be specified, but not
both.
AEMOV_RQ_CCID Character 12 Change control id
AEMOV_RQ_COMM Character 40 Comment
AEMOV_RQ_SYN Character 1 Synchronize (Y/N)
AEMOV_RQ_WIT_HIS Character 1 Move with history (Y/N)
AEMOV_RQ_BYP_DEL Character 1 Bypass element delete (Y/N)

Chapter 2. API Function Calls 2-59

2.19 Move Element Action

Field Length Description

AEMOV_RQ_SIGNIN Character 1 Sign-in element (Y/N). Y is the default
AEMOV_RQ_RETA_ Character 1 Retain sign-out (Y/N)
SIGNO
AEMOV_RQ_SIGNO_TO Character 8 Sign-out element to userid
AEMOV_RQ_JUMP Character 1 Move across environment
AEMOV_RQ_RESERVE Character 3 ** Reserved field **
AEMOV_RQ_WCCID_ Character 1 Where CCID type (A/C/R). C is the
TYP default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AEMOV_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AEMOV_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

2-60 Endevor for OS/390 API Guide

 2.20 Print Element Action

2.20 Print Element Action

The print element action API function call prints selected information about an element or
library member, depending on the data entered in the FROM clause. You can print from
Endevor or selected output libraries (for example, a PDS).

Assembler: ENHAEPRE

COBOL: ECHAEPRE

2.20.1 AEPRE_RQ Request Structure Fields

Immediately following the header is the data area of the AEPRE_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names. The stage id field is supported by the
API, but not by SCL.

Field Length Description

AEPRE_RQ_ELM Character 10 Element name
AEPRE_RQ_ELM_THRU Character 10 Through element name
AEPRE_RQ_VERSION Character 2 Element version (1-99)
AEPRE_RQ_LEVEL Character 2 Element level (0-99)
AEPRE_RQ_ENV Character 8 Environment name
AEPRE_RQ_SYSTEM Character 8 System name
AEPRE_RQ_SUBSYS Character 8 Subsystem name
AEPRE_RQ_TYPE Character 8 Type name
AEPRE_RQ_STG_ID Character 1 Stage id. Either stage id or stage
number must be specified, but not both.
AEPRE_RQ_STG_NUM Character 1 Stage number (1/2). Either stage id or
stage number must be specified, but not
both.
AEPRE_RQ_DDN Character 8 File or DD name. C1PRINT is the
default

Chapter 2. API Function Calls 2-61

2.20 Print Element Action

Field Length Description

AEPRE_RQ_NOCC Character 1 Suppress headings (Y/N)
AEPRE_RQ_COMP Character 1 Request is for component data (Y/N)
AEPRE_RQ_PRT_OPT Character 1 Type of print requested (B/C/H/M/S). B
is the default. The M option is not
allowed if the request is for component
data
AEPRE_RQ_SEARCH Character 1 Search map (Y/N). Y is the default
AEPRE_RQ_RESERVE Character 3 ** Reserved field **
AEPRE_RQ_WCCID_TYP Character 1 Where CCID type (A/C/R). C is the
default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AEPRE_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AEPRE_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

2-62 Endevor for OS/390 API Guide

 2.21 Print Member Element Action

2.21 Print Member Element Action

The print member element action API function call prints selected information about the
member you specify. You can print from Endevor or from selected output libraries (for
example, a PDS).

Assembler: ENHAEPRM

COBOL: ECHAEPRM

2.21.1 AEPRM_RQ Request Structure Fields

Immediately following the header is the data area of the AEPRM_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

Field Length Description

AEPRM_RQ_MBR Character 10 Member name
AEPRM_RQ_MBR_ Character 10 Through member name
THRU
AEPRM_RQ_DDN Character 8 Source file or DD name where
member(s) reside. Either DDN or DSN
must be specified, but not both.
AEPRM_RQ_DSN Character 44 Source data set name where member(s)
reside. Either DDN or DSN must be
specified, but not both.
AEPRM_RQ_TDDN Character 8 Target file or DD name. C1PRINT is
the default.

Chapter 2. API Function Calls 2-63

2.22 Retrieve Element Action

2.22 Retrieve Element Action

The retrieve element action API function call copies an element to a user data set.

Assembler: ENHAERET

COBOL: ECHAERET

2.22.1 AERET_RQ Request Structure Fields

Immediately following the header is the data area of the AERET_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AERET_RQ_ELM Character 10 Element name
AERET_RQ_ELM_THRU Character 10 Through element name
AERET_RQ_VERSION Character 2 Element version (1-99)
AERET_RQ_LEVEL Character 2 Element level (0-99)
AERET_RQ_ENV Character 8 Environment name
AERET_RQ_SYSTEM Character 8 System name
AERET_RQ_SUBSYS Character 8 Subsystem name
AERET_RQ_TYPE Character 8 Type name
AERET_RQ_STG_ID Character 1 Stage id. Either stage id or stage
number must be specified, but not both.
AERET_RQ_STG_NUM Character 1 Stage number (1/2). Either stage id or
stage number must be specified, but not
both.
AERET_RQ_FILE Character 8 Target file or DD name. Either DDN or
DSN must be specified, but not both
AERET_RQ_DSN Character 44 Target data set name. Either DDN or
DSN must be specified, but not both

2-64 Endevor for OS/390 API Guide

 2.22 Retrieve Element Action

Field Length Description

AERET_RQ_MBR Character 10 Target PDS member name must be blank
when through element name is specified.
AERET_RQ_CCID Character 12 Change control id
AERET_RQ_COMM Character 40 Comment
AERET_RQ_REPLACE Character 1 Replace member (Y/N)
AERET_RQ_NO_SIGNO Character 1 No signout (Y/N)
AERET_RQ_EXPAND Character 1 Expand includes (Y/N)
AERET_RQ_OVESIGNO Character 1 Override signout (Y/N)
AERET_RQ_SEARCH Character 1 Search map (Y/N). Y is the default
AERET_RQ_RESERVE Character 3 ** Reserved field **
AERET_RQ_WCCID_ Character 1 Where CCID type (A/C/R). C is the
TYP default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AERET_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AERET_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

Chapter 2. API Function Calls 2-65

2.23 Signin Element Action

2.23 Signin Element Action

The signin element action API function call removes a user signout associated with an
element. It also enables you to sign out or reassign an element to another user.

Assembler: ENHAESIG

COBOL: ECHAESIG

2.23.1 AESIG_RQ Request Structure Fields

Immediately following the header is the data area of the AESIG_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AESIG_RQ_ELM Character 10 Element name
AESIG_RQ_ELM_THRU Character 10 Through element name
AESIG_RQ_ENV Character 8 Environment name
AESIG_RQ_SYSTEM Character 8 System name
AESIG_RQ_SUBSYS Character 8 Subsystem name
AESIG_RQ_TYPE Character 8 Type name
AESIG_RQ_STG_ID Character 1 Stage id
AESIG_RQ_STG_NUM Character 1 Stage number (1/2)
AESIG_RQ_OVESIGNO Character 1 Override signout (Y/N)
AESIG_RQ_SIGNO_TO Character 8 Signout to userid
AESIG_RQ_SEARCH Character 1 Search map (Y/N). Y is the default
AESIG_RQ_RESERVE Character 3 ** Reserved field **
AESIG_RQ_WCCID_TYP Character 1 Where CCID type (A/C/R). C is the
default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.

2-66 Endevor for OS/390 API Guide

 2.23 Signin Element Action

Field Length Description

AESIG_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AESIG_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

Chapter 2. API Function Calls 2-67

2.24 Transfer Element Action

2.24 Transfer Element Action

The transfer element action API function call transfers an element from one location to
another.
Note: Only the Endevor to Endevor type transfer action is supported.

Assembler: ENHAETRA

COBOL: ECHAETRA

2.24.1 AETRA_RQ Request Structure Fields

Immediately following the header is the data area of the AETRA_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

The where CCID clause is limited to eight CCID values and the where processor group
clause is limited to eight processor group names.

Field Length Description

AETRA_RQ_ELM Character 10 From element name
AETRA_RQ_ELM_THRU Character 10 Through element name
AETRA_RQ_VERSION Character 2 From element version (1-99). Not
allowed if thru element is specified.
AETRA_RQ_LEVEL Character 2 From element level (0-99). Not allowed
if thru element is specified.
AETRA_RQ_TELM Character 10 Target element name. Not allowed if
thru element is specified.
AETRA_RQ_ENV Character 8 From environment name
AETRA_RQ_SYSTEM Character 8 From system name
AETRA_RQ_SUBSYS Character 8 From subsystem name
AETRA_RQ_TYPE Character 8 From type name
AETRA_RQ_STG_ID Character 1 From stage id. Either stage id or stage
number must be specified, but not both.

2-68 Endevor for OS/390 API Guide

 2.24 Transfer Element Action

Field Length Description

AETRA_RQ_STG_NUM Character 1 From stage number (1/2). Either stage
id or stage number must be specified,
but not both.
AETRA_RQ_TENV Character 8 Target environment name
AETRA_RQ_TSYSTEM Character 8 Target system name
AETRA_RQ_TSUBSYS Character 8 Target subsystem name
AETRA_RQ_TTYPE Character 8 Target type name
AETRA_RQ_TSTG_ID Character 1 Target stage id. Either target stage id or
target stage number must be specified,
but not both.
AETRA_RQ_TSTG_NUM Character 1 Target stage number (1/2). Either target
stage id or target stage number must be
specified, but not both.
AETRA_RQ_CCID Character 12 Change control id
AETRA_RQ_COMM Character 40 Comment
AETRA_RQ_NEWVER Character 2 New target element version
AETRA_RQ_IGN_GFAIL Character 1 Ignore generate fail
AETRA_RQ_BYP_ Character 1 Bypass generate processor
GENPRO
AETRA_RQ_PROGRO Character 8 Processor group name
AETRA_RQ_OVESIGNO Character 1 Override signout (Y/N)
AETRA_RQ_BYP_ Character 1 Bypass element delete (Y/N)
ELMDEL
AETRA_RQ_BYP_ Character 1 Bypass delete processor (Y/N)
DELPRO
AETRA_RQ_WIT_HIS Character 1 Move with history (Y/N)
AETRA_RQ_SYN Character 1 Synchronize (Y/N)
AETRA_RQ_SIGNIN Character 1 Sign-in element (Y/N)
AETRA_RQ_RETA_ Character 1 Retain sign-out (Y/N)
SIGNO
AETRA_RQ_SIGNO_TO Character 8 Sign-out element to this user
AETRA_RQ_RESERVE Character 3 ** Reserved field **

Chapter 2. API Function Calls 2-69

2.24 Transfer Element Action

Field Length Description

AETRA_RQ_WCCID_ Character 1 Where CCID type (A/C/R). C is the
TYP default value. If activated, the
CCID_WHERE_ALL optional feature
changes the default to A.
AETRA_RQ_WCCID Character 12 1st where CCID value
Character 84 2nd through 8th where CCID values
AETRA_RQ_WPROGRO Character 8 1st where processor group value
Character 56 2nd through 8th processor group values

2-70 Endevor for OS/390 API Guide

 2.25 Update Element Action

2.25 Update Element Action

The update element action API function call updates an element in Stage 1, thereby cre-
ating a new level for the element in Stage 1. Elements are updated only if there are
differences between the incoming source in the FROM location and the target Stage 1
source.

Assembler: ENHAEUPD

COBOL: ECHAEUPD

2.25.1 AEUPD_RQ Request Structure Fields

Immediately following the header is the data area of the AEUPD_RQ request structure.
The request structure is where you set your selection criteria.

All request selection fields are explained in the following table. For default values, see
the Endevor for OS/390 SCL Reference Manual.

Field Length Description

AEUPD_RQ_ELM Character 10 Element name
AEUPD_RQ_ELM_THRU Character 10 Through element name
AEUPD_RQ_DDN Character 8 File or DD name where member(s)
reside. Either DDN or DSN must be
specified, but not both.
AEUPD_RQ_DSN Character 44 Data set name where member(s) reside.
Either DDN or DSN must be specified,
but not both.
AEUPD_RQ_MBR Character 10 PDS member name
AEUPD_RQ_ENV Character 8 Environment name
AEUPD_RQ_SYSTEM Character 8 System name
AEUPD_RQ_SUBSYS Character 8 Subsystem name
AEUPD_RQ_TYPE Character 8 Type name
AEUPD_RQ_CCID Character 12 Change control id
AEUPD_RQ_COMM Character 40 Comment
AEUPD_RQ_DEL Character 1 Delete input source (Y/N)
AEUPD_RQ_OVESIGNO Character 1 Override signout (Y/N)

Chapter 2. API Function Calls 2-71

2.25 Update Element Action

Field Length Description

AEUPD_RQ_BYP_ Character 1 Bypass generate processor (Y/N)
GENPRO
AEUPD_RQ_PROGRO Character 8 Processor group name
AEUPD_RQ_RESERVE Character 3 ** Reserved field **

2-72 Endevor for OS/390 API Guide

Chapter 3. API Return Codes and Reason Codes

3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

3.2 Return Code and Reason Code Descriptions . . . . . . . . . . . . . . . . . . . . 3-4

Chapter 3. API Return Codes and Reason Codes 3-1

3-2 Endevor for OS/390 API Guide
 3.1 Overview

3.1 Overview

The Endevor API uses return codes and reason codes to report on the status of your API
function calls. The return code is presented back to the user in two ways, through reg-
ister 15 and through the AACTL_RTNCODE field.

The following lists all possible return codes that may result after an Endevor API func-
tion call.

Return Code Description

00 I - Informational. Processing concluded normally. Message is issued
for informational purposes only.
04 W - Warning. An error was encountered which was not serious enough
to terminate processing.
08 C - Caution. An error was encountered which may prevent further
processing.
12 E - Error. An error was encountered that terminated processing of the
current action but allowed Endevor to continue with the next action
request.
16 S - Severe. A severe error was encountered that prevented Endevor
from completing the requested action. Processing will terminate imme-
diately. This category includes internal, system, and I/O errors.
20 F - Fatal. No further processing is possible.

Chapter 3. API Return Codes and Reason Codes 3-3

3.2 Return Code and Reason Code Descriptions

3.2 Return Code and Reason Code Descriptions

Each return code has a reason code associated with it. Below lists all possible reason
codes that may accompany a return code. The reason code is presented back to the user
via register 0 and through the AACTL_REASON field.

RC RE Problem Explanation
00 000 No problems Request ended successfully.
04 001 Environment not found Occurs on ALENV function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

stucture: The IMR message code (for
example IMGR001E).
04 002 Stage not found Occurs on ALSTG function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR001E).
04 003 System not found Occurs on ALSYS function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR005E).

3-4 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
04 004 Subsystem not found Occurs on ALSBS function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR005E).
04 005 Type not found Occurs on ALTYP function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR013E).
04 006 Element not found Occurs on ALELM function calls. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR009E).
04 007 Processor group not Occurs on an ALPGR function call. An
found IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR013E).

Chapter 3. API Return Codes and Reason Codes 3-5

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
04 008 Data set not found Occurs on an ALDSN function call. An
IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR005E).
04 009 Approver group not Occurs on an ALAGR function call. An
found IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR018E).
04 010 Approver junction not Occurs on an ALAGJ function call. An
found IMR error message is associated with
this error. The message can be found in
the output message file specified through
the control structure. If the EN$TRAPI
DD statement is included, the message
will also appear there.

The high message id field in the control

structure: The IMR message code (for
example IMGR019E).
04 13 Requested version/level An element function call was issued
not found with a version or level that does not
exist or an illogical element function call
was issued (for example, changes of
vv.11 1.00).

The high message id field in the control

structure: AP04013W.

3-6 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
04 14 No component data An element component function call was
exists issued. The element exists, but there is
no component data.

The high message id field in the control

structure: AP04014W.
12 001 Reserved field error A request structure contains data within
one of its reserved fields. The only
valid character is a blank. An error
message is written out to the file refer-
ence by the BSTERR DD statement.
The message contains more information
concerning the error.

The high message id field in the control

structure: AP12001E.
12 002 Field value error A request structure contains invalid data
within one of its fields. An error
message is written out to the file refer-
ence by the BSTERR DD statement.
The message contains more information
concerning the error.

The high message id field in the control

structure: AP12002E.
12 003 $IMR error An IMR error occurred while processing
an extract function call. The message
associated with this error can be found
in the output message file which was
specified through the control structure.
If the EN$TRAPI DD statement was
included, the message will also appear
there.

The high message id field in the control

structure: The IMR message code

Chapter 3. API Return Codes and Reason Codes 3-7

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
12 004 File validation error A validation error was detected on an
output file by C1SSDVLD. An API
message also with the Endevor vali-
dation error message is written out to
the trace data set (EN$TRAPI), if speci-
fied in the JCL stream. A WTO
message is issued for the Endevor vali-
dation error.

The high message id field in the control

structure: AP12004E.
12 005 File RECFM error An unsupported RECFM of 'U' was used
on an output file (either the message file
or a list/extract file). A WTO message
is issued and if the EN$TRAPI DD
statement was included, the message
will also appear there.

The high message id field in the control

structure: AP12005E.
12 006 List file I/O error An I/O error occurred while writing a
record to the output list file. An API
message is written to the trace file,
EN$TRAPI, if specified. If the user has
a message output file, the actual
Endevor error message will be written
there.

The high message id field in the control

structure: AP12006E.
12 007 Message file I/O error An I/O error occurred while writing a
record to the message file. An API
message is written to the trace file,
EN$TRAPI, if specified.

The high message id field in the control

structure: AP12007E.

3-8 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
12 008 $SMR error A $SMR error occurred while proc-
essing an extract function call. The
message associated with this error can
be found in the output message file
which was specified through the control
structure. If the EN$TRAPI DD state-
ment was included, the message will
also appear there.

The high message id field in the control

structure: The SMR message code
12 009 Extract file I/O error An I/O error occurred while writing a
record to the output extract file. An
API message is written to the trace file,
EN$TRAPI, if specified. If the user has
a message output file, the actual
Endevor error message will be written
there.

The high message id field in the control

structure: AP12009E
12 010 Storage unavailable Storage was unavailable. Increase the
region size and try again. An error
message is written out to the file refer-
ence by the BSTERR DD statement.
The message contains more information
concerning the error.

The high message id field in the control

structure: AP12010E.
16 001 AACTL_SHUTDOWN The shutdown flag specified in the
is invalid control structure was incorrect. Valid
settings are 'Y', 'N' or a blank. No
error message is produced.

The high message id field in the control

structure: AP16001S.
16 002 AACTL_MSG_DDN is The message file's DD name was not
invalid allocated. Make sure that the DD state-
ment is specified in the JCL stream. No
error message is produced.

The high message id field in the control

structure: AP16002S.

Chapter 3. API Return Codes and Reason Codes 3-9

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
16 003 Too many request struc- ENA$NDVR was presented with a mul-
tures tiple request structure. Only one request
may be presented to the interface. No
error message is produced.

The high message id field in the control

structure: AP16003S.
16 004 No request structure ENA$NDVR was called without a
request structure. No error message is
produced.

The high message id field in the control

structure: AP16004S.
16 005 Too many response ENA$NDVR was presented with a mul-
structures tiple response structure. Only one
response may be presented to the inter-
face. No error message is produced.

The high message id field in the control

structure: AP16005S.
16 006 No response structure ENA$NDVR was called without a
response structure. No error message is
produced.

The high message id field in the control

structure: AP16006S.
16 007 Request not response ENA$NDVR was presented with a
response structure that does not corre-
spond to the request structure. No error
message is produced.

The high message id field in the control

structure: AP16007S.
16 008 AACTL_LIST_DDN is The list file's DD name was not allo-
invalid cated. Make sure that the DD statement
is specified in the JCL stream. No error
message is produced.

The high message id field in the control

structure: API6008S.

3-10 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
16 009 C1BMINIT failed Endevor initialization failed -
C1BMINIT. An error message is
written out to the file reference by the
BSTERR DD statement. The message
contains more information concerning
the error. The API server terminates.
20 001 Control structure eye- ENA$NDVR was presented with a
catcher is invalid control structure which does not have a
valid eye-catcher string. The control
structure return and reason codes will
not be set. The codes will be returned
through register 15 and 0 respectfully.
The control structure cannot be used to
return the codes since its structure is
damaged.
20 002 Control structure id is ENA$NDVR was presented with a
invalid control structure which has an invalid
control structure id. The control struc-
ture return and reason codes will not be
set. The codes will be returned through
register 15 and 0 respectfully. The
control structure cannot be used to
return the codes since its structure is
damaged.
20 003 Control structure ENA$NDVR was presented with a
version number is control structure which does not have a
invalid valid version number. The control
structure return and reason codes will
not be set. The codes will be returned
through register 15 and 0 respectfully.
The control structure cannot be used to
return the codes since its structure is
damaged.
20 004 Control structure length ENA$NDVR was presented with a
is invalid control structure which has an invalid
control structure length value. The
control structure return and reason codes
will not be set. The codes will be
returned through register 15 and 0
respectfully. The control structure cannot
be used to return the codes since its
structure is damaged.

Chapter 3. API Return Codes and Reason Codes 3-11

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
20 005 ROLLIST error Internal error: ROLLIST error. The
ROLFSPEC is not valid. An API
message is written to the BSTAPI DD
file.

The high message id field in the control

structure: AP20005S.
20 006 ROLFFUNC error Internal error: ROLLIST error. The
ROLFFUNC is not valid. An API
message is written to the BSTAPI DD
file.

The high message id field in the control

structure: AP20006S.
20 007 Type not in ROLLIST Internal error: ROLLIST error. Type
not found in ROL-LIST. An API
message is written to the BSTAPI DD
file.

The high message id field in the control

structure: AP20007S.
20 008 Invalid type in Internal error: ROLLIST error. Invalid
ROLLIST type found in ROL-LIST. An API
message is written to the BSTAPI DD
file.

The high message id field in the control

structure: AP20008S.
20 009 $PINIT failed $PINIT failure during an API function
call. An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20009S.
20 010 REQMSG not in Internal error: ROLLIST error.
ROLLIST OTREQMSG not found in ROL-LIST.
An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20010S.

3-12 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
20 011 $PGET failed $PGET failure during an API function
call. An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20011S.
20 012 $PSEND failed $PSEND failure during an API function
call. An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20012S.
20 013 $BGETSTG for $API Storage could not be obtained. An API
failed message is written to the BSTAPI DD
file.

The high message id field in the control

structure: AP20013S.
20 014 $BATTACH failed Attach failure. An API message is
written to the BSTAPI DD file.

The high message id field in the control

structure: AP20014S.
20 015 $PWAIT failed $PWAIT failure during an API function
call. An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: o AP20015S.
20 016 $PRECV failed $PRECV failure during an API function
call. An API message is written to the
BSTAPI DD file. The high message id
field in the control structure will be set
to AP20016S
20 017 $PFREE failed $PFREE failure during an API function
call. An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20017S.

Chapter 3. API Return Codes and Reason Codes 3-13

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
20 018 Internal message area is Internal error. Storage area within the
too small ENA$NDVR interface program is too
small to construct the message request.

The high message id field in the control

structure: AP20018S.
20 019 Structure cross check Internal error. The structure pointers in
the message request does not point to
the correct structure headers that are
contained in the message request. An
API message is written to the BSTAPI
DD file.

The high message id field in the control

structure: AP20019S.
20 020 AAMSG structure Internal error. The AAMSG structure list
improper (message request) is improper. The
pointer list is not an even multiple. An
API message is written to the BSTAPI
DD file.

The high message id field in the control

structure: AP20020S.
20 021 AAMSG structure not Internal error. The AAMSG structure
found list does not contain an entry for the
structure returned by the API server.
An API message is written to the
BSTAPI DD file.

The high message id field in the control

structure: AP20021S.
20 022 P2PMSG structure Internal error. The P-to-P structure sent
improper by the API server is improper. The total
structure size within the AAMSG did
not agree with the P-to-P structure. An
API message is written to the BSTAPI
DD file.

The high message id field in the control

structure: AP20022S.

3-14 Endevor for OS/390 API Guide

 3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
20 023 ENAPIMGR parameter Internal error. The API manager
length error received its parameter list with an
invalid length. An API message is
written to the BSTERR DD file. The
API server terminates.
20 024 ENAPIMGR parameter Internal error. The API manager
EYE error expected to receive a parameter list that
maps to $AAPRM. The parameter it
received did not contain the identifier
string of '$AAPRM'. An API message
is written to the BSTERR DD file. The
API server terminates.
20 025 $PHDL failed Internal error. $PHDL failure during an
API server initialization. An API
message is written to the BSTERR DD
file. The API server terminates.
20 026 Invalid request id Not used
20 027 AAMSG structure EYE Internal error. The API received an
invalid invalid message structure which did not
conform to its expected ENHAAMSG
layout. An API message is written to
the BSTERR DD file. The server waits
for another message request.
20 028 No control structure in The API server received a request but
AAMSG the control structure was not found after
the message structure AAMSG. An API
message is written to the BSTERR DD
file. The server waits for another
message request.
20 029 Control structure is The API server received a request which
invalid had an invalid control structure. An
API message is written to the BSTERR
DD file. The server waits for another
message request.

Chapter 3. API Return Codes and Reason Codes 3-15

3.2 Return Code and Reason Code Descriptions

RC RE Problem Explanation
20 030 Structure lengths do not The API server expects to receive a
add up message control request with four
structures: AAMSG, AACTL, request,
and response structure. During the vali-
dation process the total lengths of these
structures did not agree with the value
stored in the message structure. An API
message is written to the BSTERR DD
file. The server waits for another
message request.
20 031 Request structure The request structure within a message
invalid request structure could not be identified.
An API message is written to the
BSTERR DD file. The server waits for
another message request.
20 032 Response structure The response structure within a message
invalid request structure could not be identified.
An API message is written to the
BSTERR DD file. The server waits for
another message request.

3-16 Endevor for OS/390 API Guide

Chapter 4. API Execution Reports and Trace Facilities

4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

4.1.1 Execution Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.2 Trace Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.2 API Execution Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4.2.1 Element Action Function Call Sample Report . . . . . . . . . . . . . . . . 4-4
4.2.2 Inventory List Function Sample Report . . . . . . . . . . . . . . . . . . . . 4-5
4.3 The API Diagnostic Trace — BC1PAPI . . . . . . . . . . . . . . . . . . . . . . 4-7
4.4 The API Internal Trace — EN$TRAPI . . . . . . . . . . . . . . . . . . . . . . . 4-8

Chapter 4. API Execution Reports and Trace Facilities 4-1

4-2 Endevor for OS/390 API Guide
 4.1 Overview

4.1 Overview

This chapter contains procedures and sample output for execution reports and trace facili-
ties.

4.1.1 Execution Reports

Endevor for OS/390 provides execution reports that record processing information for
API function calls.

4.1.2 Trace Facilities

Endevor for OS/390 API provides trace facilities to facilitate debugging your code.
When a trace facility is executed, it writes the status and current view of the data to an
output file when an API call is executed. If there is a problem completing the call, the
trace facilities record the area in which the error occurred.

You should refer to trace data found in BSTERR, BSTAPI, and EN$TRAPI DD name
datasets if the return code and reason code from the API request directs you to. You
should scan the files looking for error messages that might be recorded in the files. All
error messages are documented in Endevor for OS/390 Error Codes and Messages. If an
internal error occurs, you should send all traces to Technical Support.

Endevor for OS/390 API provides two trace facilities:

The API Diagnostic Trace

The API Internal Trace

Chapter 4. API Execution Reports and Trace Facilities 4-3

4.2 API Execution Reports

4.2 API Execution Reports

The API writes an execution report to the message file defined by the
AACTL_MSG_DDN file after each function call is processed. This report includes the
requested function calls and their options and the actual processing that occurred.

Sample execution reports are provided below for the following API function calls:

Element action

Inventory list

4.2.1 Element Action Function Call Sample Report

This sample report format is used to record the processing information for all of the API
element action function calls.

This report consists of two parts: first, the data from the request structure is formatted and
printed in a format similar to the output you receive when executing an Endevor batch
request; the second part is the action execution log. This is the exact same output you
receive when executing an Endevor foreground or batch action.

From this report, you can determine the ADD element action request field values and
determine the results of your request by viewing the execution log.

4-4 Endevor for OS/390 API Guide

 4.2 API Execution Reports

(C) 1987,2+++ Computer Associates International, Inc. 18JUL++ 15:32:43 PAGE 1

E N D E V O R A P I E X E C U T I O N R E P O R T
15:32:43 API++++I STARTING PRINT OF API ACTION REQUEST DATA
15:32:43 API++++I
15:32:43 API++++I ADD ELEMENT: APIB
15:32:43 API++++I THROUGH: APIU
15:32:43 API++++I FROM DSNAME: BST.BUCFR+2.APISRC
15:32:43 API++++I TO ENVIRONMENT: INT
15:32:43 API++++I SYSTEM: NDVRMVS
15:32:43 API++++I SUBSYSTEM: FHB
15:32:43 API++++I TYPE: COBCOPY
15:32:43 API++++I OPTIONS
15:32:43 API++++I CCID: CCIDVALUEADD
15:32:43 API++++I COMMENT: COMMENTADD123456789+123456789+
15:32:43 API++++I UPDATE IF PRESENT: Y
15:32:43 API++++I DELETE INPUT SOURCE: N
15:32:43 API++++I OVERRIDE SIGNOUT: Y
15:32:43 API++++I BYPASS GENERATE PROCESSOR: N
15:32:43 API++++I
15:32:43 API++++I API ACTION REQUEST DATA SUCCESSFULLY PRINTED
15:32:43 API++++I

15:32:43 C1Y++15I STARTING PARSE OF REQUEST CARDS

STATEMENT #1
15:32:43 C1Y++16I REQUEST CARDS SUCCESSFULLY PARSED

15:32:44 C1G+2+2I ACTION #1 / STMT #1

15:32:44 C1G+2+3I ADD ELEMENT APIB
15:32:44 C1G+2+5I FROM DSNAME: BST.BUCFR+2.APISRC MEMBER: APIB
15:32:44 C1G+2+4I TO ENVIRONMENT: INT SYSTEM: NDVRMVS SUBSYSTEM
15:32:44 C1G+232I OPTIONS: OVERRIDE SIGNOUT, UPDATE
15:32:44 C1G+232I CCID: CCIDVALUEADD
15:32:44 C1G+232I COMMENT: COMMENTADD123456789+123456789+
15:32:45 C1G+265I PROCESSOR GROUP KNOPROCK FOR ELEMENT APIB WAS
15:32:46 SMGR122W NO ELEMENT SOURCE CHANGES DETECTED
15:32:46 SMGR125I ELEMENT APIB +1.+2 NOT UPDATED BY BST.APISRC(APIB)
15:32:46 C1G+2++I REQUEST PROCESSING FOR ELM APIB COMPLETED

4.2.2 Inventory List Function Sample Report

This sample report format is used to record the processing information for all of the API
inventory list function calls.

This report consists of two parts: first, the data from the request structure is formatted and
printed in a format similar to the output you receive when executing an Endevor batch
request; the second part is a summary of how many records were read and selected and
the highest return and reason codes detected.

From this report, you can see that three records were selected and written to a file defined
to the APIEXTR DD statement and that the highest return code was zero.

Chapter 4. API Execution Reports and Trace Facilities 4-5

4.2 API Execution Reports

(C) 1987,2+++ Computer Associates International, Inc. 18JUL++ 13:19:12 PAGE 1

E N D E V O R A P I E X E C U T I O N R E P O R T
13:19:12 API+1+1I BEGINNING OF API ACTION PROCESSING
API+1++I LIST ENVIRONMENT
API+1++I TO DDNAME: APIEXTR
API+1++I ENVIRONMENT: INT
API+1++I THRU ENVIRONMENT: PRD
API+1++I OPTIONS
API+1++I PATH: L RETURN: A SEARCH: A
API+1++I
API+1++I API ACTION REQUEST DATA SUCCESSFULLY PRINTED
API+1++I
13:19:12 API+1+2I DISPATCHING API ACTION
13:19:12 API++++I RETURNED COUNT=++++3, SELECTED COUNT=++++3
13:19:12 API++++I PROCESSING COMPLETE - RC=+++++ REASON=+++++

4-6 Endevor for OS/390 API Guide

 4.3 The API Diagnostic Trace — BC1PAPI

4.3 The API Diagnostic Trace — BC1PAPI

The API Diagnostic Trace records diagnostic and informational messages for each API
transaction. The trace should be run only at the request of Endevor technical support.
To activate the Endevor API Diagnostic Trace, include the following DD statement in
your JCL stream:
//BSTAPI DD SYSOUT=A

Below is an example of an output file created with the BC1PAPI trace facility.

(C) 1987,2+++ Computer Associates International Endevor for OS/39+ +2/+4/++ +7:34:++ PAGE 1

DIAGNOSTICS OUTPUT LISTING

BC1PAPI - INITIALIZING - VERSION +1/21/99 12.49
BC1PAPI SEND MESSAGE REQUEST
BC1PAPI APISTG $BGETSTG RC=++++4 RESULT=NEWSTG
BC1PAPI MAIN2+++ $PINQ RC=+++12
BC1PAPI MAIN2+++ $PINIT RC=+++++
BC1PAPI MAIN21++ $PGET RC=+++++
BC1PAPI BMSG2+++ - ++4+ ++++ +++A +++1 $CTL +++6EF2+
BC1PAPI BMSG2+++ - ++5+ ++++ +45+ +++1 LELQ +++6EF6+
BC1PAPI BMSG2+++ - +39C ++++ +451 +++1 LELR 8++6EFB+
BC1PAPI MAIN23++ $PSEND RC=++++4
BC1PAPI ISSUING ATTACH FOR API SERVER
BC1PAPI ATTA1+++ $PWAIT RC=+++++
BC1PAPI ATTA2+++ $PRECV RC=+++++
BC1PAPI ATTA3+++ $PFREE RC=+++++
BC1PAPI MAIN23++ $PSEND RC=+++++

Chapter 4. API Execution Reports and Trace Facilities 4-7

4.4 The API Internal Trace — EN$TRAPI

4.4 The API Internal Trace — EN$TRAPI

The API Internal Trace records detailed internal trace information along with API data
block dumps. This trace should only be used to debug a problem.

To activate the Endevor API Internal Trace, include the following DD statement in your
JCL stream:
//EN$TRAPI DD SYSOUT=A

Below are examples of output files created with the EN$TRAPI trace facility.

(C) 1987,2+++ Computer Associates International Endevor for OS/39+ +2/+4/++ +7:34:+4 PAGE 1

ENDEVOR/OS/39+ API INTERNAL TRACE

ENAPIMGR - INITIALIZING - VERSION +1/21/99 12.41
ENAPIMGR INIT3+++ $PINIT RC=+++++
ENAPIMGR INIT4+++ $PHDL RC=+++++
ENAPIMGR INIT5+++ $PGET RC=+++++
ENAPIMGR INIT6+++ $PSEND RC=+++++
ENAPIMGR INIT7+++ MSGIORTN INTERCEPT ESTABLISHED
ENAPIMGR PROC1+++ $PRECV RC=+++++
ENAPIMGR PROC3+++ COMPLETE MESSAGE RECEIVED - ADDRESS=+++49154 LENGTH=+45C
+++49154 (+++++) ++6++45C 5BD4E2C7 +++++++3 ++++++++ ++++++++ ++++++++ ++++++++ ++++++++ K - K$MSG K
+++49174 (+++2+) ++++++++ ++++++++ ++++++++ ++++++++ ++4+++++ +++A+++1 5BC3E3D3 D4E2C7F3 K $CTLMSG3 K
+++49194 (+++4+) C6C9D3C5 C5E7E3F1 C5D3D44+ 4+4+4+4+ 4+4+4+4+ 4+4+4+4+ F+F+F+F+ F+F+F+F+ KFILEEXT1ELM ++++++++K
+++491B4 (+++6+) F+F+F+F+ F+F+F+F+ F+F+F+F+ F+F+F+F+ ++5+++++ +45++++1 D3C5D3D8 D7C1C14+ K++++++++++++++++ & & LELQPAA K
+++491D4 (+++8+) C9D5E34+ 4+4+4+4+ D5C4E5D9 D4E5E24+ C2C1E2C5 4+4+4+4+ C1E2D4D7 C7D44+4+ KINT NDVRMVS BASE ASMPGM K
+++491F4 (+++A+) C2C3F1D7 C9D4C7D9 4+4+F14+ 4+4+4+4+ 4+4+4+4+ C1C2C3C4 C6C74+4+ 4+4+4+4+ KBC1PIMGR 1 ABCDFG K
+++49214 (+++C+) +39C++++ +451+++1 D3C5D3D9 4+4+4+4+ 4+4+4+4+ 4+4+4+4+ 4+4+4+4+ 4+4+4+4+ K LELR K

The following example contains additional trace information for an ADD element action
function call.

(C) 1987,2+++ Computer Associates International Endevor for OS/39+ +2/+4/++ +7:34:+4 PAGE 1

ENDEVOR/OS/39+ API INTERNAL TRACE

ENAPIMGR CALL1+2+ MSG PRB, ADDMSG , IS SUCCESSFULLY SETUP
ENAPIACT XADDRUTN -- ADD ACTION ROUTINE
ENAPIACT PRINTRTN - PRINT ACTION REQUEST BLOCK ROUTINE
ENAPIACT PRINTRTN - CALLING ENAPIPRA MODULE
ENAPIACT PRINTRTN - CALL TO ENAPIPRA COMPLETE. RC=+++++
ENAPIACT PRINTRTN COMPLETE - RC=+++++ RE=+++++
ENAPIACT DACTRUTN - DISPATCH ACTION ROUTINE
ENAPIACT DACTRUTN - CALLING C1BM41++ MODULE
ENAPIACT DACTRUTN - CALL TO C1BM41++ COMPLETE. RC=+++++
ENAPIACT DACTRUTN - CALLING C1BM42++ MODULE
ENAPIACT DACTRUTN - ERRORS DETECTED BY CALLED MODULE
ENAPIACT DACTRUTN COMPLETE - RC=++++4 RE=+++++
ENAPIACT XADDRUTN COMPLETE - RC=++++4 RE=+++++
ENAPIMGR CALL4+++ ROUTINE RC=++++4 RE=+++++
ENAPIMGR PROC4+++ COMPLETE MESSAGE SENT - ADDRESS=+++4B154

4-8 Endevor for OS/390 API Guide

Appendix A. Sample API Programs

A.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3

A.2 Executing an API Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
A.2.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
A.3 Sample COBOL Program — CCIDRPT1 . . . . . . . . . . . . . . . . . . . . A-6
A.3.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
A.3.2 CCIDRPT1 Output Report . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
A.4 JCL to Execute CCIDRPT1 — BC1JRAPI . . . . . . . . . . . . . . . . . . . A-8
A.4.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
A.5 Sample List Environment Function Call — ENHAAPGM . . . . . . . . . . . A-11
A.5.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
A.6 JCL to Execute ENHAAPGM — BC1JAPGM . . . . . . . . . . . . . . . . . A-12
A.6.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12
A.7 Sample Element Action Function Call — ENHAEPGM . . . . . . . . . . . . A-14
A.7.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14
A.8 JCL to Execute ENHAEPGM — BC1JEPGM . . . . . . . . . . . . . . . . . A-15
A.8.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15
A.9 Sample Inventory List Function Call — ENTBJAPI . . . . . . . . . . . . . . A-17
A.9.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-17
A.10 JCL to Execute ENTBJAPI — BC1JAAPI . . . . . . . . . . . . . . . . . . . A-18
A.10.1 JCL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-18

Appendix A. Sample API Programs A-1

A-2 Endevor for OS/390 API Guide
 A.1 Overview

A.1 Overview

This appendix provides a description of sample programs and JCL that you can use to
test the Endevor for OS/390 API. The appendix includes:

A description of how to execute an API program outside of a processor using the
NDVRC1 program.

A description of COBOL program CCIDRPT1 that produces a list of elements and
creates a CCID cross-reference report

JCL to execute program CCIDRPT1

A description of Assembler program ENHAAPGM that produces a list of environ-
ments and writes the responses to an output file

JCL to execute program ENHAAPGM

A description of Assembler program ENHAEPGM that executes each of the element
action function calls and writes the responses to an output file.

JCL to execute program ENHAEPGM

A description of Assembler program ENTBJAPI that executes different inventory list
function calls and writes the responses to an output file.

JCL to execute program ENTBJAPI

Appendix A. Sample API Programs A-3

A.2 Executing an API Program

A.2 Executing an API Program

The NDVRC1 program allows you to execute a program that issues Endevor for OS/390
API function calls outside of a processor.

A.2.1 Description
You must execute NDVRC1 and pass the name of your program through the PARM=
parameter on the EXEC statement. If your program requires parameter data, you can
append it to the parameter string using a comma to separate the program name from your
parameter data.

For example:
//STEP1 EXEC PGM=NDVRC1,PARM='TESTAPI1,DATA1,DATA2'

NDVRC1 executes program TESTAPI1 and passes the following parameter information
to the program through register 1:
R1 = +++81+1+

at address 81+1+ the following is found: +++81+2+

at address 81+2+ the following data (shown in HEX) can be found:

+++C6BC4C1E3C1F16BC4C1E3C1F2

where:

length value = 12

parm data = ,data1,data2

NDVRC1 reserves the first eight characters of the PARM parameter for the program
name. All other parameters, starting with the ninth character, are passed to the API
program as parameter data. For Assembler programs, register 1 contains an address that
points to the parameter data where the first two bytes contain the parameter length fol-
lowed by the parameter data.
Note: If you do not want the first comma passed to the program, enter the data imme-
diately after the program name and omit entering the first comma.

COBOL Users: NDVRC1 reserves the first eight characters of the PARM parameter for
the program name. All other parameters, starting with the ninth character, are passed to
the API program and placed into the LINKAGE SECTION storage provided in the API
program. The API program must contain the PROCEDURE DIVISION USING storage
clause, where storage is the 01-level name of the variable specified in the LINKAGE
SECTION.

A-4 Endevor for OS/390 API Guide

 A.2 Executing an API Program

Using the same parameter information as shown in the Assembler example, the storage
defined in the LINKAGE SECTION must be defined as 14 bytes in length and contain
the two byte-length value (000C) in binary, PIC 9(2) COMP, followed by the 12 bytes of
parameter data (,data1,data2) in character format, PIC X(12).

Appendix A. Sample API Programs A-5

A.3 Sample COBOL Program — CCIDRPT1

A.3 Sample COBOL Program — CCIDRPT1

The COBOL program, CCIDRPT1, produces a list of elements based on user input and
creates a CCID cross-reference report. This program was written to show an application
use of the API feature. JCL that you can use to execute this program appears in the next
section.

A.3.1 Description
The source for this program is distributed with Endevor for OS/390 as member name
CCIDRPT1 in the iprfx.iqual.SOURCE data set.

The CCIDRPT1 program performs the following actions:

1. Issues an API list element function call and writes the responses to an output file.
2. Reads each response record.
3. Issues an API extract element function call specifying the change option. A second
file is created containing the changes associated with each element.
4. Extracts the CCID data and writes it to a sort file; the CCID data precedes the
element source statements.
5. Reads the sort file and generates a report.

Only source code is provided for this program. Review the source and make any desired
modifications. You must compile and link-edit this module into the
uprfx.uqual.AUTHLIB library before attempting to execute it. There are no restrictions
on linkage editor AMODE/RMODE parameters. (AMODE=31,RMODE=ANY or
AMODE=24,RMODE=24).

A-6 Endevor for OS/390 API Guide

 A.3 Sample COBOL Program — CCIDRPT1

A.3.2 CCIDRPT1 Output Report

Below is a portion of the report output from program CCIDRPT1:

ENDEVOR INVENTORY REPORT BY CCID PAGE 1

KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
K K
K THIS REPORT PRODUCES A CCID CROSS REFERENCE ON ELEMENT K
K INVENTORY SPECIFIED BY THE USER. SEE SPECIFICATION INPUT K
K BELOW. K
K K
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK

USER SPECIFICATIONS:
FROM ENVIRON:QAS STGID:2 SYSTEM:NDVRMVS SUBSYS:BASE ELEMENT:K TYPE:ASMPGM
TO ENVIRON: STGID:
SEARCH SETTING - CURRENT LOCATION
PATH SETTING - PHYSICAL
PROCESS FIRST OCCURRENCES OF ELEMENT AND TYPE

ENDEVOR INVENTORY REPORT BY CCID PAGE 2

CCID: I579711+

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
C1GP2+++ ASMPGM +1.54 24OCT99 13:33 OLEJU+1 QAS 2 NDVRMVS BASE disallow batch adm/ pkg w/in processors

CCID: NMAN

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
C1GSCIPO ASMPGM +1.17 24JUL99 13:15 OLEJU+1 QAS 2 NDVRMVS BASE ADD LOGIC FOR NAME CCID VALID FLAG

CCID: OFT

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
ENCOPTBL ASMPGM +1.+9 16OCT99 14:25 BUCFR+2 QAS 2 NDVRMVS BASE Optional Features Table Source

CCID: PKGESI

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
CONMSGSP ASMPGM +1.48 +5SEP96 11:44 DYSRO+1 QAS 2 NDVRMVS BASE Add package ESI support
C1SPMISC ASMPGM +1.38 31OCT99 1+:33 BUCFR+2 QAS 2 NDVRMVS BASE ESI SUPPORT
ENMP3CRE ASMPGM +1.+3 21JUL99 +9:11 DYSRO+1 QAS 2 NDVRMVS BASE Package exit 1 support

CCID: P++++644

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
C1BML+1+ ASMPGM +1.28 2+MAY96 +9:+9 BERBE+2 QAS 2 NDVRMVS BASE S+c4 at +82 during clear footprnt cmd.

CCID: P++++7+1

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
C1BR2+++ ASMPGM +1.25 3+DEC99 11:++ BERBE+2 QAS 2 NDVRMVS BASE zero days value for reports

CCID: P++++894

ELEMENT TYPE VV.LL DATE TIME USER ENVIRON SID SYSTEM SUBSYS COMMENT
ENBX14++ ASMPGM +1.19 24DEC99 16:26 BERBE+2 QAS 2 NDVRMVS BASE included copybooks have space b4 period

Appendix A. Sample API Programs A-7

A.4 JCL to Execute CCIDRPT1 — BC1JRAPI

A.4 JCL to Execute CCIDRPT1 — BC1JRAPI

The JCL for this program is distributed with Endevor for OS/390 as member name
BC1JRAPI in the iprfx.iqual.JCL data set. This job shows how to execute program
CCIDRPT1. The load module along with its source is distributed.

A.4.1 JCL
The JCL to execute program CCIDRPT1 appears below. Look at the JCL comment state-
ments that describe updates you need to make before you execute this JCL stream.

In this example, DD name, MSG3FILE, describes the message output file and DD name,
EXT1ELM, describes the output file for the element extract responses.
//K ( COPY JOBCARD )
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//K K
//K BC1JRAPI - THIS IS SAMPLE JCL THAT EXECUTES PROGRAM CCIDRPT1 K
//K WHICH IS DISTRIBUTED IN SOURCE AS AN EXAMPLE OF K
//K HOW TO WRITE (USE) THE ENDEVOR API FACILITY. K
//K K
//K THE FOLLOWING UPDATES MUST BE MADE TO THIS JCL BEFORE K
//K IT CAN BE EXECUTED: K
//K K
//K 1. UPDATE THE JOBCARD TO REFLECT CORRECT SITE INFORMATION K
//K 2. REVIEW THAT THE STEPLIB AND CONLIB DATA SET NAMES ARE K
//K CORRECT. K
//K - uprfx.uqual.AUTHLIB K
//K - iprfx.iqual.AUTHEXT K
//K - iprfx.iqual.CONLIB K
//K 3. MODIFY THE PROGRAMS DATA INPUT. AS AN EXAMPLE, THE K
//K INPUT DATA HAS A SINGLE REQUEST. K
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//STEP1 EXEC PGM=NDVRC1,PARM='CCIDRPT1',DYNAMNBR=15++,REGION=4+96K
//STEPLIB DD DSN=uprfx.uqual.AUTHLIB,DISP=SHR
// DD DSN=iprfx.iqual.AUTHEXT,DISP=SHR
//CONLIB DD DSN=iprfx.iqual.CONLIB,DISP=SHR
//SYSOUT DD SYSOUT=K

A-8 Endevor for OS/390 API Guide

 A.4 JCL to Execute CCIDRPT1 — BC1JRAPI

//SYSPRINT DD SYSOUT=K
//BSTERR DD SYSOUT=K
//MSG3FILE DD DSN=&&MSG3FILE,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=FB,LRECL=133,BLKSIZE=133++)
//EXT1ELM DD DSN=&&EXT1ELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=VB,LRECL=2+48,BLKSIZE=228++)
//EXT2ELM DD DSN=&&EXT2ELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=VB,LRECL=2+48,BLKSIZE=228++)
//WORKELM DD DSN=&&WORKELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=FB,LRECL=115,BLKSIZE=115+)
//SORTELM DD DSN=&&SORTELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=FB,LRECL=115,BLKSIZE=115+)
//CCIDRPT1 DD SYSOUT=K
//K
//K SYSIN DATA STRUCTURE INFORMATION
//K
//K COLUMN 1 = 'K' STATEMENT TREATED AS A LINE COMMENT & WILL
//K ON THE REPORT
//K
//K COLUMNS 1-4 = 'ELOC' INPUT REQUEST ID
//K COLUMN 5 = PATH SETTING
//K 'L' = LOGICAL PATH
//K 'P' = PHYSICAL PATH
//K COLUMN 6 = SEARCH SETTING
//K 'A' = SEARCH ALL
//K 'B' = SEARCH BETWEEN
//K 'N' = NO SEARCH
//K 'E' = SEARCH NEXT
//K 'R' = SEARCH RANGE
//K COLUMN 7 = RETURN SETTING
//K 'A' = RETURN ALL HITS
//K 'F' = RETURN FIRST HIT
//K COLUMNS 8-15 = ENVIRONMENT NAME (EXPLICIT)
//K COLUMN 16 = STAGE ID (EXPLICIT)
//K COLUMNS 17-24 = SYSTEM NAME (MAY BE WILD)
//K COLUMNS 25-32 = SUBSYSTEM NAME (MAY BE WILD)
//K COLUMNS 33-42 = ELEMENT NAME (MAY BE WILD)
//K COLUMNS 43-5+ = TYPE NAME (MAY BE WILD)
//K COLUMNS 51-58 = TO ENVIRON NAME SPECIFY ON SEARCH ='B' OR 'R'
//K & MUST BE EXPLICIT
//K COLUMN 59 = TO STAGE ID SPECIFY ON SEARCH ='B' OR 'R'
//K & MUST BE EXPLICIT
//K COLUMNS 6+-69 = TO ELEMENT NAME (MAY BE WILD)

Appendix A. Sample API Programs A-9

A.4 JCL to Execute CCIDRPT1 — BC1JRAPI

//K +----1----+----2----+----3----+----4----+----5----+----6----+----7--
//SYSIN DD K
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
K K
K THIS REPORT PRODUCES A CCID CROSS REFERENCE ON ELEMENT K
K INVENTORY SPECIFIED BY THE USER, SEE SPECIFICATION INPUT BELOW. K
K K
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
ELOCPNFINT 1NDVRMVS BASE K ASMPGM
//K PRINT ANY MESSAGES
//STEP2 EXEC PGM=IEBGENER
//SYSPRINT DD DUMMY
//SYSIN DD DUMMY
//SYSUT1 DD DSN=&&MSG3FILE,DISP=(OLD,DELETE)
//SYSUT2 DD SYSOUT=K

A-10 Endevor for OS/390 API Guide

 A.4 JCL to Execute CCIDRPT1 — BC1JRAPI

A.5 Sample List Environment Function Call — ENHAAPGM

The sample Assembler program, ENHAAPGM, produces a list of environments and

writes the responses to an output file. You can use this program as a template for cre-
ating other inventory list function calls. For example, you can modify the request struc-
ture field values to produce a list of types or add an additional function call to produce a
list of systems. JCL to execute this program appears in the next section.

A.5.1 Description
The source for this program is distributed with Endevor for OS/390 as member name
ENHAAPGM in the iprfx.iqual.SOURCE data set. The ENHAAPGM program performs
the following actions:
1. Issues a request to the API to read the MCF and build a list of all the environments.
2. Writes the list of environments to an output file.
3. Writes any inventory or source management messages to the message data set.

Only source code is provided for this program. Review the source and make any neces-
sary modifications. The names of the starting and ending environments and the search
options are candidates for modifications. You must assemble and link-edit this module
into uprfx.uqual.AUTHLIB before attempting to execute it. There are no restrictions on
linkage editor AMODE/RMODE parameters (AMODE=31,RMODE=ANY or
AMODE=24,RMODE=24).

Appendix A. Sample API Programs A-11

A.5 Sample List Environment Function Call — ENHAAPGM

A.6 JCL to Execute ENHAAPGM — BC1JAPGM

The JCL in this section is distributed with Endevor for OS/390 as member name
BC1JAPGM in the iprfx.iqual.JCL data set. This job can be tailored and used to execute
the ENHAAPGM program. The sample API program must be executed from an author-
ized library.

A.6.1 JCL
The JCL to execute program ENHAAPGM appears below.

In this example, the DD name APIMSGS describes the message file, in this case
SYSOUT, and APILIST describes the response output file for the list environment func-
tion call.
//K(JOBCARD)
//K-------------------------------------------------------------------K
//K K
//K (C) 1987,2+++ COMPUTER ASSOCIATES INTERNATIONAL, INC. K
//K K
//K NAME: BC1JAPGM K
//K K
//K PURPOSE - THIS IS SAMPLE JCL TO INVOKE THE ASSEMBLER K
//K SAMPLE API PROGRAM: ENHAAPGM K
//K K
//K THE FOLLOWING UPDATES MUST BE MADE TO THIS JCL BEFORE K
//K IT CAN BE EXECUTED: K
//K K
//K 1. UPDATE THE JOBCARD TO REFLECT CORRECT SITE INFORMATION K
//K 2. REVIEW THAT THE STEPLIB DD STATMENT CONCATENATION CONTAINS K
//K THE NAME OF THE AUTHORIZED LIBRARY CONTAINING THE SAMPLE K
//K PROGRAM AND THE ENDEVOR DEFAULTS TABLE. K
//K 3. REVIEW THAT THE CONLIB DD STATMENT CONCATENATION CONTAINS K
//K THE NAME OF THE LIBRARY CONTAINING THE ENDEVOR SOFTWARE. K
//K-------------------------------------------------------------------K
//STEP1 EXEC PGM=ENHAAPGM,REGION=4+96K
//STEPLIB DD DISP=SHR,DSN=uprfx.uqual.AUTHLIB
// DD DISP=SHR,DSN=iprfx.iqual.AUTHLIB
//CONLIB DD DISP=SHR,DSN=iprfx.iqual.CONLIB
//SYSOUT DD SYSOUT=K
//SYSPRINT DD SYSOUT=K
//BSTERR DD SYSOUT=K
//APIMSGS DD SYSOUT=K,
// DCB=(RECFM=FB,LRECL=133,BLKSIZE=133++)
//APIEXTR DD DSN=&&EXT1ELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=VB,LRECL=2+48,BLKSIZE=228++)
//K TRACE FACILITY K
//KBSTAPI DD SYSOUT=K
//KEN$TRAPI DD SYSOUT=K

A-12 Endevor for OS/390 API Guide

 A.6 JCL to Execute ENHAAPGM — BC1JAPGM

//K-------------------------------------------------------------------K
//K PRINT EXTRACTED LIST OF ENVIRONMENTS
//K-------------------------------------------------------------------K
//STEP2 EXEC PGM=IEBGENER
//SYSPRINT DD DUMMY
//SYSIN DD DUMMY
//SYSUT1 DD DSN=&&EXT1ELM,DISP=(OLD,DELETE)
//SYSUT2 DD SYSOUT=K

Appendix A. Sample API Programs A-13

A.7 Sample Element Action Function Call — ENHAEPGM

A.7 Sample Element Action Function Call — ENHAEPGM

The sample Assembler program, ENHAEPGM, illustrates the use of all the API element
action function calls. JCL to execute this program appears in the next section.

A.7.1 Description
The source for this program is distributed with Endevor for OS/390 as member name
ENHAEPGM in the iprfx.iqual.SOURCE data set. The ENHAEPGM program contains
logic to execute each of the element action function calls supported by the API.

Only source code is provided for this program. Review the source and make any neces-
sary modifications. In order for this program to operate, the name of the input and output
data sets must be modified and the name of the member being ADDed and UPDATEd
must exist in the input library. Also, the inventory location information (ENV, SYS,
SYSSUB, etc.) must exist.

You must assemble and link-edit this module into uprfx.uqual.AUTHLIB before
attempting to execute it. There are no restrictions on the linkage editor
AMODE/RMODE parameters. AMODE=31,RMODE=ANY is recommended.

A-14 Endevor for OS/390 API Guide

 A.8 JCL to Execute ENHAEPGM — BC1JEPGM

A.8 JCL to Execute ENHAEPGM — BC1JEPGM

The JCL in this section is distributed with Endevor for OS/390 as member name
BC1JEPGM in the iprfx.iqual.JCL data set. This job can be tailored and used to execute
the ENHAEPGM program. This sample API program must be executed from an author-
ized library.

A.8.1 JCL
The JCL to execute program ENHAEPGM appears below.

In this example, a series of DD names describes the message, input and output files
defined in the sample program. Also, the optional trace DD statements are coded.
//K(JOBCARD)
//K-------------------------------------------------------------------K
//K K
//K (C) 1987,2+++ COMPUTER ASSOCIATES INTERNATIONAL, INC. K
//K K
//K NAME: BC1JEPGM K
//K K
//K PURPOSE - THIS IS SAMPLE JCL TO INVOKE THE ASSEMBLER K
//K SAMPLE API ELEMENT ACTION PROGRAM: ENHAEPGM K
//K K
//K THE FOLLOWING UPDATES MUST BE MADE TO THIS JCL BEFORE K
//K IT CAN BE EXECUTED: K
//K K
//K 1. UPDATE THE JOBCARD TO REFLECT CORRECT SITE INFORMATION K
//K 2. REVIEW THAT THE STEPLIB DD STATEMENT CONCATENATION CONTAINS K
//K THE NAME OF THE AUTHORIZED LIBRARY CONTAINING THE SAMPLE K
//K PROGRAM AND THE ENDEVOR DEFAULTS TABLE. K
//K 3. REVIEW THAT THE CONLIB DD STATMENT CONCATENATION CONTAINS K
//K THE NAME OF THE LIBRARY CONTAINING THE ENDEVOR SOFTWARE. K
//K 4. THE SAMPLE PROGRAM EXPECTS SEVERAL MEMBERS TO EXIST IN THE K
//K UPRFX.UQUAL.SRCLIB. MAKE SURE THIS LIBRARY EXISTS AT YOUR K
//K SITE OR CHANGE THE DATA SET NAME IN THIS JCL TO ONE THAT K
//K DOES AND CREATE 3 COPYBOOK MEMBERS IN THIS LIBRARY; K
//K APIB--BASE COPYBOOK K
//K APIU--BASE COPYBOOK WITH SEVERAL MODIFICATIONS K
//K APIR--COPY OF APIB FOR DELETE AND RETRIEVE ACTIONS K
//K-------------------------------------------------------------------K
//STEP1 EXEC PGM=NDVRC1,PARM='ENHAEPGM',REGION=4+96K
//STEPLIB DD DISP=SHR,DSN=UPRFX.UQUAL.AUTHLIB (C1DEFLTS, USER PGM)
// DD DISP=SHR,DSN=IPRFX.IQUAL.AUTHLIB (E/OS39+ AUTH PGMS)
//CONLIB DD DISP=SHR,DSN=IPRFX.IQUAL.LOADLIB (E/OS39+ SOFTWARE)

Appendix A. Sample API Programs A-15

A.8 JCL to Execute ENHAEPGM — BC1JEPGM

//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//K API MESSAGES DD STMT FROM THE AACTL_MSG_DD CONTROL FIELD.
//K IF NOT SPECIFIED, DD NAME DEFAULT OF APIMSGS IS USED.
//K EACH REQUEST SHOULD HAVE A UNIQUE MESSAGE FILE.
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//APIMSGS DD SYSOUT=K,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=+)
//ADDMSG DD SYSOUT=K
//DELMSG DD SYSOUT=K
//GENMSG DD SYSOUT=K
//MOVMSG DD SYSOUT=K
//PREMSG DD SYSOUT=K
//PRMMSG DD SYSOUT=K
//RETMSG DD SYSOUT=K
//SIGMSG DD SYSOUT=K
//TRAMSG DD SYSOUT=K
//UPDMSG DD SYSOUT=K
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//K TO/FROM DD NAMES SPECIFIED ON THE ELEMENT ACTION REQUESTS
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//ADDDDNMI DD DISP=SHR,DSN=UPRFX.UQUAL.SRCLIB
//PREDDNMO DD SYSOUT=K,DCB=(RECFM=FBA,LRECL=133,BLKSIZE=+)
//PRMDDNMI DD DISP=SHR,DSN=UPRFX.UQUAL.SRCLIB
//PRMDDNMO DD SYSOUT=K
//RETDDNMO DD DISP=SHR,DSN=UPRFX.UQUAL.SRCLIB
//UPDDDNMI DD DISP=SHR,DSN=UPRFX.UQUAL.SRCLIB
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//K OPTIONAL TRACE DD STATEMENTS
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//BSTERR DD SYSOUT=K (ENDEVOR TRACE)
//BSTAPI DD SYSOUT=K (API DIAGNOSTIC TRACE)
//EN$TRAPI DD SYSOUT=K (API INTERNAL TRACE)

A-16 Endevor for OS/390 API Guide

 A.9 Sample Inventory List Function Call — ENTBJAPI

A.9 Sample Inventory List Function Call — ENTBJAPI

This program allows you to specify input statements to execute inventory list function
calls. Based on user input, it builds control, request, and response structures and executes
the API to process the function calls. It writes the responses to an output file.

A.9.1 Description
See comment statements in the JCL stream for a full description of each available API
inventory list function call. Each function call is made up of a control structure state-
ment, a request structure statement, and a RUN statement. The API structures are created
from the control structure statement and the request structure statement. The RUN state-
ment executes the API. More than one function call can be executed in one job by speci-
fying a set of statements for each function call. If you are issuing a request to shutdown
the API server only, a request structure statement is not required, as illustrated in the JCL
stream.

The QUIT statement should be the last statement coded in the input stream, which termi-
nates the program.

Appendix A. Sample API Programs A-17

A.10 JCL to Execute ENTBJAPI — BC1JAAPI

A.10 JCL to Execute ENTBJAPI — BC1JAAPI

The JCL in this section is distributed with Endevor for OS/390 as member name
BC1JAAPI in the iprfx.iqual.JCL data set. This job shows how to execute program
ENTBJAPI. This program is distributed as a load module only.

A.10.1 JCL
The JCL to execute program ENTBJAPI appears below. Look at the JCL comment state-
ments that describe updates you need to make before you execute this JCL stream.

In this example, DD name, MSG3FILE, describes the message output file and DD name,
EXT1ELM, describes the output file for the API responses.
//K ( COPY JOBCARD )
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//K K
//K BC1JAAPI - THIS IS SAMPLE JCL TO INVOKE THE ASSEMBLER K
//K VERSION OF OUR SAMPLE API ENDEVOR APPLICATION K
//K PROGRAM: ENTBJAPI K
//K K
//K THE FOLLOWING UPDATES MUST BE MADE TO THIS JCL BEFORE K
//K IT CAN BE EXECUTED: K
//K K
//K 1. UPDATE THE JOBCARD TO REFLECT CORRECT SITE INFORMATION K
//K 2. REVIEW THAT THE STEPLIB AND CONLIB DATA SET NAMES ARE K
//K CORRECT. K
//K - uprfx.uqual.AUTHLIB K
//K - iprfx.iqual.AUTHEXT K
//K - iprfx.iqual.CONLIB K
//K 3. ADD THE NECESSARY DD STATEMENTS NEEDED TO PROCESS ANY K
//K ADDITIONAL API LIST REQUESTS. CURRENTLY THIS JOB IS SETUP K
//K TO HANDLE ONLY ONE LIST REQUEST. K
//K 4. MODIFY THE PROGRAMS DATA INPUT IN STEP1. AS AN EXAMPLE, THE K
//K INPUT DATA HAS A SINGLE ELEMENT EXTRACT REQUEST. K
//KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
//STEP1 EXEC PGM=NDVRC1,PARM='ENTBJAPI',DYNAMNBR=15++,REGION=4+96K
//STEPLIB DD DSN=uprfx.uqual.AUTHLIB,DISP=SHR
// DD DSN=iprfx.iqual.AUTHEXT,DISP=SHR
//CONLIB DD DSN=iprfx.iqual.CONLIB,DISP=SHR
//SYSOUT DD SYSOUT=K
//SYSPRINT DD SYSOUT=K
//BSTERR DD SYSOUT=K
//BSTAPI DD SYSOUT=K
//MSG3FILE DD DSN=&&MSG3FILE,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=FB,LRECL=133,BLKSIZE=133++)
//EXT1ELM DD DSN=&&EXT1ELM,DISP=(NEW,PASS),
// UNIT=SYSDA,SPACE=(TRK,(5,5)),
// DCB=(RECFM=VB,LRECL=2+48,BLKSIZE=228++)
//SYSIN DD K

A-18 Endevor for OS/390 API Guide

 A.10 JCL to Execute ENTBJAPI — BC1JAAPI

K RECORD ID IS IN COLUMNS 1-5

K
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK AACTL = CONTROL STRUCTURE INFORMATION
K V - COLUMN 6 = SHUTDOWN FLAG STRUCTURE
K VVVVVVVV - COLUMN 7-14 IS THE MSG FILE DDNAME
K VVVVVVVV - COLUMN 15-22 OUTPUT DATA FILE DDNAME
K
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
K FOR MANY REQUESTS, THE FOLLOWING SETTINGS ARE APPROPRIATE
K V - COLUMN 6 = PATH SETTING
K = ' ' FOR LOGICAL
K = 'L' FOR LOGICAL
K = 'P' FOR PHYSICAL
K V - COLUMN 7 = RETURN SETTING
K = ' ' FOR FIRST FOUND
K = 'F' FOR FIRST FOUND
K = 'A' FOR ALL FOUND
K V - COLUMN 8 = SEARCH SETTING
K = ' ' FOR FIRST
K = 'A' FOR ALL
K = 'B' FOR BETWEEN
K = 'E' FOR NEXT
K = 'N' FOR NO
K = 'R' FOR RANGE
K V - COLUMN 9 = UNUSED
K
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALENV = LIST ENVIRONMENT STRUCTURE INFORMATION
K V - COLUMN 6 = PATH SETTING
K V - COLUMN 7 = RETURN SETTING
K V - COLUMN 8 = SEARCH SETTING
K V - COLUMN 9 = UNUSED
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 = TO ENVIRONMENT NAME
K V - COLUMN 27 = TO STAGE ID
K NOTE: IF BETWEEN/RANGE SETTINGS ARE USED, YOU NEED TO SPECIFY
K TO-ENV AND TO-STAGE, OTHERWISE LEAVE BLANK.
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALSTG = LIST STAGE STRUCTURE INFORMATION
K V - COLUMN 6 = PATH SETTING
K V - COLUMN 7 = RETURN SETTING
K V - COLUMN 8 = SEARCH SETTING
K V - COLUMN 9 = UNUSED
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 = TO ENVIRONMENT NAME
K V - COLUMN 27 = TO STAGE ID
K NOTE: IF BETWEEN/RANGE SETTINGS ARE USED, YOU NEED TO SPECIFY
K TO-ENV AND TO-STAGE, OTHERWISE LEAVE BLANK.
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--

Appendix A. Sample API Programs A-19

A.10 JCL to Execute ENTBJAPI — BC1JAAPI

KKKKK ALSYS = LIST SYSTEM STRUCTURE INFORMATION

K V - COLUMN 6 = PATH SETTING
K V - COLUMN 7 = RETURN SETTING
K V - COLUMN 8 = SEARCH SETTING
K V - COLUMN 9 = UNUSED
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VVVVVVVV - COLUMN 27-34 = TO ENV NAME
K V - COLUMN 35 = TO STAGE ID
K NOTE: IF BETWEEN/RANGE SETTINGS ARE USED, YOU NEED TO SPECIFY
K TO-ENV AND TO-STAGE, OTHERWISE LEAVE BLANK.
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALSBS = LIST SUBSYSTEM STRUCTURE INFORMATION
K V - COLUMN 6 = PATH SETTING
K V - COLUMN 7 = RETURN SETTING
K V - COLUMN 8 = SEARCH SETTING
K V - COLUMN 9 = UNUSED
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VVVVVVVV - COLUMN 27-34 SUBSYSTEM NAME
K VVVVVVVV - COLUMN 35-42 = TO ENV NAME
K V - COLUMN 43 = TO STAGE ID
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALSIT = LIST SITE STRUCTURE INFORMATION
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALELM = LIST ELEMENT STRUCTURE INFORMATION
K V - COLUMN 6 = PATH SETTING
K V - COLUMN 7 = RETURN SETTING
K V - COLUMN 8 = SEARCH SETTING
K V - COLUMN 9 = UNUSED
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VVVVVVVV - COLUMN 27-34 SUBSYSTEM NAME
K COLUMN 35-44 = ELEMENT NAME VVVVVVVVVV
K COLUMN 45-52 = TYPE NAME VVVVVVVV
K COLUMN 53-6+ = TO-ENV NAME VVVVVVVV
K COLUMN 61 = TO-STAGE ID V
K COLUMN 62-71 = THRU-ELEMENT NAME VVVVVVVVVV
K NOTE: IF BETWEEN/RANGE SETTINGS ARE USED, YOU NEED TO SPECIFY
K TO-ENV AND TO-STAGE, OTHERWISE LEAVE BLANK.

A-20 Endevor for OS/390 API Guide

 A.10 JCL to Execute ENTBJAPI — BC1JAAPI

K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALPGR = LIST PROCESSOR GROUP STRUCTURE INFORMATION
K V - COLUMN 7 = RETURN SETTING
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VVVVVVVV - COLUMN 27-34 TYPE NAME
K VVVVVVVV - COLUMN 35-42 PROC GROUP
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALDSN = LIST DATA SET STRUCTURE INFORMATION
K V - COLUMN 7 = RETURN SETTING
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VV - COLUMN 27-28 DATA SET ID
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALAGR = LIST APPROVER GROUP STRUCTURE INFORMATION
K V - COLUMN 7 = RETURN SETTING
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K VVVVVVVV - COLUMN 18-25 APPROVER GROUP NAME
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK ALAGJ = LIST APPROVER JUNCTION STRUCTURE INFORMATION
K V - COLUMN 7 = RETURN SETTING
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K VVVVVVVVVVVVVVVVVVVVVVVVV - COLUMN 18-42 APPR JUNCTION
K VVVVVVVV - COLUMN 18-25 SYSTEM
K VVVVVVVV - COLUMN 26-33 SUBSYSTEM
K VVVVVVVV - COLUMN 34-41 TYPE
K V - COLUMN 34-41 STAGE NUM
K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
KKKKK AEELM = EXTRACT ELEMENT STRUCTURE INFORMATION
K V - COLUMN 6 = FORMAT SETTING
K = ' ' FOR NO FORMAT, JUST EXTRACT ELEMENT
K = 'B' FOR ENDEVOR BROWSE DISPLAY FORMAT
K = 'C' FOR ENDEVOR CHANGE DISPLAY FORMAT
K = 'H' FOR ENDEVOR HISTORY DISPLAY FORMAT
K V - COLUMN 7 = RECORD TYPE SETTING
K = 'E' FOR ELEMENT
K = 'C' FOR COMPONENT
K VVVVVVVV - COLUMN 1+-17 ENVIRONMENT NAME
K V - COLUMN 18 = STAGE ID
K VVVVVVVV - COLUMN 19-26 SYSTEM NAME
K VVVVVVVV - COLUMN 27-34 SUBSYSTEM NAME
K COLUMN 35-44 = ELEMENT NAME VVVVVVVVVV
K COLUMN 45-52 = TYPE NAME VVVVVVVV
K COLUMN 53-54 = VERSION VV
K COLUMN 55-56 = LEVEL VV

Appendix A. Sample API Programs A-21

A.10 JCL to Execute ENTBJAPI — BC1JAAPI

K---+----1----+----2----+----3----+----4----+----5----+----6----+----7--
K EXTRACT AN ELEMENT WITH NO FORMAT - CURRENT VERSION & LEVEL
AACTL MSG3FILEEXT1ELM
AEELM E INT 1NDVRMVS BASE BC1PFPVL ASMPGM
RUN
K LAST CALL, ENSURE THAT THE API SERVER IS SHUTDOWN.
AACTLY
RUN
QUIT
//K
//K PRINT ANY MESSAGES
//STEP2 EXEC PGM=IEBGENER
//SYSPRINT DD DUMMY
//SYSIN DD DUMMY
//SYSUT1 DD DSN=&&MSG3FILE,DISP=(OLD,DELETE)
//SYSUT2 DD SYSOUT=K
//K
//K PRINT EXTRACTED ELEMENT
//STEP3 EXEC PGM=IEBGENER
//SYSPRINT DD DUMMY
//SYSIN DD DUMMY
//SYSUT1 DD DSN=&&EXT1ELM,DISP=(OLD,DELETE)
//SYSUT2 DD SYSOUT=K

A-22 Endevor for OS/390 API Guide