Starting the BCM Web API server

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

The following is an example of starting the TSO/E address space and then starting the BCM Web API server in that space.

  1. Using your z/OS user ID, perform z/OSMF authentication.
  2. Start the TSO/E address space in which the BCM Web API server will run.

    Request line
    Post https://z/OSMFserverIPaddress/zosmf/tsoApp/tso?proc=IKJACCNT&chset=697&cpage=1047&rows=204&cols=160&rsize=50000&acct=DEFAULT
    Request body
    None
    Response body
    {"servletKey":"USERID-38-aabcaaaf","queueID":"4","sessionID":"0x37","ver":"0100",
    "tsoData":[{"TSO MESSAGE":{"VERSION":"0100","DATA":"IKJ56455I USERID LOGON IN PROGRESS AT 00:00:00 ON APRIL 1,2022"},
    {"TSO MESSAGE":{"VERSION":"0100","DATA":"READY"}},
    {"TSO PROMPT":{"VERSION":"0100","HIDDEN":"FALSE"}}],
    "reused":false,"timeout":false}
  3. Start the BCM Web API server.

    Request line

    Specify the servletKey key value included in the response body in step 2: USERID-38-aabcaaaf.

    POST https://IP-address-of-the-z/OSMF-server/zosmf/tsoApp/app/USERID-38-aabcaaaf/YKAPI
    Request body

    For the startcmd key, specify the procedure name YKAPIPRC created in To start the BCM Web API server by using a procedure, and specify the queueID key value included in the response body in step 2: 4.

    {"startcmd":"YKAPIPRC &1 &2 4" }

    If you changed the login procedure in To change the login procedure to directly start the BCM Web API server, specify the BCM Web API server name YKAPISRV instead of the procedure name YKAPIPRC.

    {"startcmd":"YKAPISRV &1 &2 4" }
    Response body

    If the BCM Web API server successfully starts, the YK7390I message is output.

    {"servletKey":"USERID-38-aabcaaaf","ver":"0100",
    "tsoData":[{"TSO MESSAGE":{"VERSION":"0100","DATA":"YK7390I The BCM Web API server has started."}}], "reused":false, "timeout":false}