Starting the BCM Web API server

Business Continuity Manager Web API Reference Guide

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

Request line

To start the BCM Web API server in the TSO/E address space.

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

Item

Description

servletKey

Specify the value of the servletKey key that was returned when the TSO/E address space was started.

Request body

{"startcmd":"Procedure-name &1 &2 queueID" }

Item

Description

startcmd

Procedure-name &1 &2 queueID

Procedure-name
Specify the name of the BCM Web API server startup procedure created in Creating a BCM Web API server startup procedure.
queueID

Specify the value of the queueID key that was returned in the response body when the TSO/E address space was started.

Response body

{"servletKey":"servletKey",
 "ver":"structure-version",
 "tsoData":[
   {"TSO MESSAGE":
     {"VERSION":"JSON-version",
      "DATA":"YK7390I BCM Web API server started."}
   }],
 "reused":false, "timeout":false
}

Key

Format

Description

servletKey

string

The same value as the servletKey key in the request line

ver

string

The version of the JSON object structure for REST API requests for z/OSMF TSO/E address space services.

For details, see the IBM manual z/OS Management Facility Programming Guide.

tsoData

object

TSO/E message

VERSION

string

The JSON version of the format of this message.

For details, see the IBM manual z/OS Management Facility Programming Guide.

reused

boolean

Reconnected indicator

For details, see the IBM manual z/OS Management Facility Programming Guide.

timeout

boolean

  • false: If the BCM Web API server has started.
  • true: If the BCM Web API server does not start within the time limit.