Stopping the BCM Web API server

Request line

Stop the BCM Web API server.

After you stop the BCM Web API server, if you want to restart it, first stop and then restart the TSO/E address space.

PUT https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/servletKey/YKAPI

Request body

{ "action":"exit" }

Response body

If no CLI commands are running

After the response is returned, the BCM Web API server will stop.

{"servletKey":"servletKey",
"ver":"structure-version",
 "tsoData":[
   {"TSO MESSAGE":
     {"VERSION":"JSON-version",
      "DATA":" YK7399I BCM Web API server ended.rc=0"}
   }],
 "reused":false, "timeout":false
}

If a CLI command is running

If you try to stop the BCM Web API server while a CLI command is running, true will be returned for the timeout key. For this reason, wait for CLI execution to finish before stopping the BCM Web API server.

{"servletKey":"servletKey",
"ver":"structure-version",
 "reused":false, "timeout":true
}

If an error occurs in the sending of the response

Follow the instructions in the error message that is output.

{"servletKey":"servletKey",
"ver":"structure-version",
 "tsoData":[
   {"TSO MESSAGE":
     {"VERSION":"JSON-version",
      "DATA":"error-bcmMsg"}
   }],
 "reused":false, "timeout":false
}