<resultsummary> element

The <resultsummary> element contains summarized information about the CICS management client interface request. The response to a CICS management client interface request must contain a <resultsummary> element.

Contained by:

<response> element

Attributes

api_source="value": If the request is not successful, contains the name of the API source; for example, "CICSPlex SM" or "CMCI". This attribute is not present in the response to a successful request.
api_function="function": If the request is not successful, contains the name of the CICS system command or CICSPlex SM API command that has failed; for example, PERFORM SET. This attribute is not present in the response to a successful request.
api_response1="value": The CICS EIBRESP code or the CICSPlex SM API EYUDA response code as a numeric value. See RESP and RESP2 options for more information about CICS RESP values and EYUDA values for information about CICSPlex SM API response codes.
api_response1_alt="value": The CICS EIBRESP code or the CICSPlex SM API EYUDA response code as a text string. See RESP and RESP2 options for more information about CICS RESP values and EYUDA values for information about CICSPlex SM API response codes.
api_response2="value": The CICS EIBRESP2 code or the CICSPlex SM API EYUDA reason code as a numeric value. The value for a successful request is 0. See RESP and RESP2 options for more information about CICS RESP2 values and EYUDA values for information about CICSPlex SM API reason codes.
api_response2_alt="value": The CICS EIBRESP2 code or the CICSPlex SM API EYUDA reason code as a text string. See RESP and RESP2 options for more information about CICS RESP2 values and EYUDA values for information about CICSPlex SM API reason codes.
recordcount="value": The total number of records returned by the request.
The recordcount attribute always indicates the total number of records in the result including those for which the request failed. If a record range is specified, the value of recordcount can be greater than the number of records returned by the request.
displayed_recordcount="value": A count of the records returned by the request.
If a record range is specified, the value of displayed_recordcount can be less than the total number of records in the result as indicated by recordcount.
successcount="value": For DELETE requests only, a count of the records for which the request succeeded.
cachetoken="value": A token identifying a results cache containing a retained set of results. A cachetoken attribute is present only in the response to a GET request that specifies the NODISCARD option. The value of cachetoken is a 16–character, fixed-length hexadecimal representation of a store clock value.

Examples

The following example shows the result of a successful DELETE request:

<resultsummary api_response1="1024" api_response1_alt="OK"
api_response2="0" api_response2_alt="" recordcount="20" 
dispayed_recordcount="20" successcount="18" />

The following example shows the result of a DELETE request that does not complete successfully:

<resultsummary api_source="CICSPlex SM" api_function="SET"  api_response1="1038" 
api_response1_alt="TABLEERROR" api_response2="1361" api_response2_alt="DATAERROR" 
recordcount="0" dispayed_recordcount="0" successcount="0"/>

The following example shows the result of a GET request that includes the NODISCARD option:

<resultsummary api_response1="1024" api_response1_alt="OK"
api_response2="0" api_response2_alt="" recordcount="2" 
dispayed_recordcount="2" cachetoken="C36E880ECAC5818B" />