Diagnostic data in the API response

If the return code for a API command request is 4 or higher, then the response from the CICS Configuration Manager server includes diagnostic data in addition to the usual return code, reason code, and task number. This diagnostic data reflects the original error code that caused the problem, matching the first error message in the CCVLOG data set in the server CICS® region for this task.

⋮
<OutputData>
  <ReturnCode> return_code </ReturnCode>  1 
  <ReasonCode> reason_code </ReasonCode>
  <TaskNo> CICS_task_number </TaskNo>
 
  <DiagData>
    <RC> return_code </RC>  1 
    <RSN> reason_code </RSN>
    <INFO> nnnnnnnn </INFO>  2 
    <INFO2> nnnnnnnnnnnnnnnn </INFO2>
    <RESP> nnnnnnnnnnnnnnnn </RESP>  3 
    <RESP2> nnnnnnnn </RESP2>
    <EIBFN> last_CICS_function_requested </EIBFN>
  </DiagData>
⋮
  <ExceptionData>  4 
    <ErrorElement>
      <Target>
        <ObjName> resource_name </ObjName>
        <ObjGroup> resource_group </ObjGroup>
        <ObjType> resource_type </ObjType>
        <LocationType> Context | CSD </LocationType>
        <LocationName> location_name </LocationName>
      </Target>
      <Messages>  5 
        <MsgLostCount> lost_count </MsglostCount>  6 
        <MsgCount> returned_count </MsgCount>
        <MsgElement> message_text </MsgElement>
 
        More message elements…
 
      </Messages>			
    </ErrorElement>
  </ExceptionData>
⋮
</OutputData>
⋮
 1 
<ReturnCode> and <ReasonCode> report the overall result for the command. <RC> and <RSN> report the first result, contributing to the overall result. For details, see Return codes and Reason codes.
 2 
<INFO> and <INFO2> are for IBM® use only.
 3 
<RESP>, <RESP2>, and <EIBFN> contain the EIBRESP, EIBRESP2, and EIBFN fields from the CICS EXEC interface block (EIB). For details, see the CICS Transaction Server for z/OS®: CICS Application Programming Reference.
 4 
The following API commands return additional exception data for resource definitions:
  • Backout
  • Copy
  • Create
  • Delete
  • Discard
  • Install
  • Migrate
  • Newcopy
  • Update

For commands that act on a single object, the exception data follows the diagnostic data. For commands that act on multiple objects, each list element in the response contains separate exception data.

 5 
<Messages> contains messages from DFHEDAP or CICS system programming interface (SPI) commands (for resource definitions in a CSD file), CICSPlex® SM (for resource definitions in a context), or the CICS Configuration Manager agent (for actions on CSD-based CICS regions).
 6 
(Only for Discard, Install, and Newcopy commands.) The amount of data for each command is limited to 32KB. If a command involves many resource definitions, then the returned message data may exceed this maximum limit, and some messages prior to the final message may be dropped from the returned data, and hence lost. lost_count indicates the number of messages lost. The final message is never dropped. For example, if a command generates 210 messages, and ten must be dropped to fit inside the 32KB limit, then messages 200 to 209 will be dropped: the returned data will contain the first 199 messages followed by the final message.

Information Information

Feedback


Timestamp icon Last updated: Friday, 7 February 2014


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic///ccv-api-diagdata.htm