API commands and distributed program link

The following table summarizes the CICS® API commands by functional area, indicating whether or not they are supported in a program invoked by a distributed program link command. Generally, if the program issues a command that is not supported, CICS returns an INVREQ condition, with a RESP2 value of 200.

Table 1. Summary of the CICS API by functional area
Functional area Command Supported?
Abend support

ABEND
ASSIGN
  ABCODE
  ASRAINTRPT
  ASRAPSW
  ASRAREGS
  ORGABCODE
HANDLE ABEND

YES
APPC mapped communication

ALLOCATE(APPC)
CONNECT PROCESS
CONVERSE
EXTRACT PROCESS
FREE CONVID
ISSUE
  ABEND
  CONFIRMATION
  ERROR
  PREPARE
  SIGNAL
 
RECEIVE
SEND
WAIT CONVID

NO
Note: These APPC commands are restricted only when they refer to the principal facility.
Signon

SIGNON
SIGNOFF

NO

Batch data interchange commands

ISSUE
   ABORT          QUERY
  ADD          RECEIVE
  END          REPLACE
  ERASE        SEND
  NOTE         WAIT

NO
BMS commands

ASSIGN
  COLOR         PAGENUM
  DESTCOUNT     PARTNPAGE
  INPARTN       PARTNS
  LDCMNEM       PARTNSET
  LDCNUM        PS
   
  MAPCOLUMN
  MAPHEIGHT
  MAPLINE
  MAPWIDTH
   OPCLASS
    
PURGE MESSAGE
RECEIVE
MAP
PARTN
 
ROUTE
SEND
  CONTROL
  MAP
  PAGE
  PARTNSET
  TEXT
  TEXT MAPPED
  TEXT NOEDIT

NO
Built-in functions

BIF DEEDIT

YES
Condition handling

HANDLE CONDITION
IGNORE CONDITION
PUSH HANDLE
POP HANDLE

YES
Console support

WRITE OPERATOR

YES
Diagnostic services

DUMP
ENTER
TRACE

YES
Environmental services

ASSIGN
  ABCODE        ABDUMP
  ABPROGRAM     APPLID
  ASRAINTRPT    ASRAKEY
  ASRAPSW       ASRAREGS
  ASRASPC       ASRASTG
   
  CMDSEC        CWALENG
  INITPARM      INITPARMLENG
  INVOKINGPROG  NETNAME
  OPERKEYS      OPID
ORGABCODE     PRINSYSID
  PROGRAM
   
  RESSEC        RESTART
  RETURNPROG    STARTCODE
  SYSID         TASKPRIORITY
  TCTUALENG     TRANPRIORITY
  TWALENG       USERID

YES
Environmental services (continued)

ASSIGN
  ALTSCRNHT     MAPLINE
  ALTSCRNWD     MAPWIDTH
  APLKYBD       MSRCONTROL
  APLTEXT       NATLANGINUSE
  BTRANS        NEXTTRANSID
   
  COLOR         NUMTAB
  DEFSCRNHT     OPCLASS
  DEFSCRNWD     OPSECURITY
  DELIMITER     OUTLINE
  DESTCOUNT     PAGENUM
   
  DESTID        PARTNPAGE
  DESTIDLENG    PARTNS
  DSSCS         PARTNSET
  DS3270        PS
  EWASUPP       QNAME
   
  EXTDS         SCRNHT
  FACILITY      SCRNWD
  FCI           SIGDATA
  GCHARS        SOSI
  GCODES        STATIONID
   
  GMMI          TELLERID
  HILIGHT       TERMCODE
  INPARTN       TERMPRIORITY
  KATAKANA      TEXTKYBD
  LANGINUSE     TEXTPRINT
  LDCMNEM       UNATTEND
   
  LDCNUM        USERNAME
  MAPCOLUMN     USERPRIORITY
  MAPHEIGHT     VALIDATION

NO
Environmental services (continued)

ADDRESS
   ACEE
   COMMAREA
   CWA
   EIB
   TCTUA  
   TWA      

YES
File control

DELETE
ENDBR
READ
READNEXT
READPREV
 
RESETBR
REWRITE
STARTBR
UNLOCK
WRITE

YES
Interval control

ASKTIME
CANCEL
DELAY
FORMATTIME
POST
 
RETRIEVE
START
WAIT EVENT

YES
Journaling

WRITE JOURNALNAME
WAIT JOURNALNAME
WRITE JOURNALNUM
WAIT JOURNALNUM

YES
Monitoring

MONITOR POINT

YES
Program control

LINK
LOAD
RELEASE
RETURN
XCTL

YES
Note: LINK, RETURN and XCTL do not support INPUTMSG.
Security

QUERY SECURITY

YES
Storage control

FREEMAIN
GETMAIN

YES
Syncpoint

SYNCPOINT

YES
Task control

ASSIGN
TASKPRIORITY
 
CHANGE TASK
DEQ
ENQ
SUSPEND
WAIT EXTERNAL

YES
Temporary storage

DELETEQ TS
READQ TS
WRITEQ TS

YES
Terminal control

ASSIGN
FACILITY
 
CONVERSE
HANDLE AID
RECEIVE
SEND
WAIT TERMINAL

NO
Transient data

DELETEQ TD
READQ TD
WRITEQ TD

YES