Error responses
An error response indicates the API command was not successful. One or more REASON values are also returned that describe the error.
Note: Note that, except for the FAILED error response, these response codes
usually indicate either an error in the user's API program (for example, failing
to discard resources when they are no longer required), or an error with the CICSPlex® SM environment (for
example, a CMAS or MAS is not available).
The following values represent an error response:
- BUSY
- A resource referred to by the command is currently being processed by another command. This situation can occur when a command that was previously issued with the NOWAIT option is processing a resource that is required by the current command. The reasons for a BUSY response are given with the commands that return it.
- DUPE
- A resource referred to by the command already exists. The reasons for a DUPE response are given with the commands that return it.
- ENVIRONERROR
- An environmental condition (such as short on storage) prevented the command from being processed. The reasons for an ENVIRONERROR response are given with the commands that return it.
- FAILED
- An unexpected problem occurred during command processing. The reasons
for a FAILED response are given with the commands that return it. In the case of a FAILED EXCEPTION response, you should check the following sources for information related to the condition:
- EYULOG
- Job log
- AUXTRACE data set
- INCOMPATIBLE
- Two or more resources referred to by the command are incompatible. The reasons for an INCOMPATIBLE response are given with the commands that return it.
- INUSE
- A resource referred to by the command is in use and, therefore, cannot be discarded. The reasons for an INUSE response are given with the commands that return it.
- INVALIDATA
- The command parameter list contains invalid data. The reason for an INVALIDATA response is always the name of the parameter that contains invalid data. The reasons are given with the commands that return this response.
- INVALIDCMD
- The command is invalid as indicated by the reason code:
- Filter
- The filter that is being built is too large or complex.
- Length
- The total length of all the inputs used in the command exceeds the maximum limit.
- N_A
- The command is invalid. Check which version of the CICS® translator was used to translate the API command. Also check that the command being used is available on the CICSPlex SM release that the program is using.
- INVALIDPARM
- The command parameter list is invalid. There are a variety of situations
that could result in an INVALIDPARM response. For example:
- Syntax error
- The syntax of an input parameter is incorrect (for example, a resource table name begins with a numeric character).
- Null parameter address
- An input parameter could not be found because the generated address for that parameter is 0.
- NOTAVAILABLE
- A required CMAS or MAS resource is not available. The reasons for a NOTAVAILABLE response are given with the commands that return it.
- NOTFOUND
- A resource referred to by the command could not be found. The reasons for a NOTFOUND response are given with the commands that return it.
- NOTPERMIT
- The API request is not permitted by the external security manager (ESM) at your enterprise. The reasons for a NOTPERMIT response are given with the commands that return it.
- SERVERGONE
- The CMAS to which the processing thread was connected is no longer active. There are no reasons associated with a response of SERVERGONE.
- TABLEERROR
- An error was detected in a resource table record (either a result set record or a CICSPlex SM definition record). The reasons for a TABLEERROR response are given with the commands that return it.
- VERSIONINVL
- An invalid version of CICSPlex SM was detected. The reasons for a VERSIONINVL response are given with the commands that return it.