IBM Support

Documentation required for RESTAPI related cases

Troubleshooting


Problem

Some issue involving RESTAPI not functioning as desired is reported.  What documentation should be collected for troubleshooting? 

Symptom

RESTAPI related issue

Environment

This set of documentation is useful for any RESTAPI issue:
(1) The api executed and json body provided in it
(2) The trace.log file from ZConnector with active traces. A sample trace.xml file is provided in the "Diagnosing the problem" section below, this can be used to activate traces on ZConnector. Deploy this file in configDropins/overrides folder just for the time you need to reproduce the scenario and then remove it (Liberty will update traces configuration immediately with no need for restart)
Usually the EQQMLOG from controller/server tasked are not needed (however it does not hurt to collect these files any way)

Diagnosing The Problem

This trace.xml file contents can be used:
<server description="enableTraces">
    <variable name="trace.specification" 
    value="com.ibm.tws.zconn.*=all"
    />
    <!--  VALUE SAMPLES -->
    <!-- 
    tws_all -> "com.ibm.tws.*=all:org.apache.wink.server.*=all"
    tws_alldefault -> "com.ibm.tws.*=error=enabled"
    tws_broker_all ->"com.ibm.scheduling.*=all:TWSAgent=all"
    tws_rest -> "com.ibm.tws.conn.*=all:com.ibm.tws.twsd.rest.*=all:org.apache.wink.server.*=all"
    tws_cli -> "com.ibm.tws.cli.*=all:com.ibm.tws.objects.*=all"
    tws_utils -> "com.ibm.tws.util.*=all"
    tws_conn -> "com.ibm.tws.conn.*=all:com.ibm.tws.objects.*=all:com.ibm.tws.updatemanager.*=all:com.ibm.tws.dao.plan.*=all"
    tws_db -> "com.ibm.tws.dao.model.*=all:com.ibm.tws.dao.rdbms.*=all"
    tws_planner -> "com.ibm.tws.planner.*=all:com.tivoli.icalendar.*=all:com.ibm.tws.runcycles.*=all:com.ibm.tws.conn.planner.*=all:com.ibm.tws.cli.planner.*=all"
    tws_secjni -> "com.ibm.tws.audit.*=all:com.ibm.tws.security.*=all"
    tws_engine_broker_all -> "com.ibm.tws.*=all:com.ibm.scheduling.*=all:TWSAgent=all"
    "com.ibm.tws.zconn.pif.impl.PifConnection=all"
     -->
    <logging traceSpecification="${trace.specification}" traceFileName="trace.log"
         maxFileSize="20" maxFiles="10" traceFormat="ENHANCED"/>
    
</server>

Resolving The Problem

Use the documentation mentioned in the "Environment" section above to resolve the issue.  

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB35","label":"Mainframe SW"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSRULV","label":"IBM Workload Scheduler for z\/OS"},"ARM Category":[{"code":"a8m0z0000001gwyAAA","label":"ZOS-\u003EIZWS-\u003EREST-API"}],"ARM Case Number":"TS007875235","Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"All Versions"}]

Document Information

Modified date:
16 February 2022

UID

ibm16557054