Starting Activities Via Rest API

Since ProcMan 5.0.4 there is a possibility to start Control-M activities via REST API. The starting of Control-M activities and Universal Object activities via REST API is very similar. So for details see ProcMan - Install and Customize Universal Object Module. This chapter describes only differences to the Universal Object module.

Request

The Control-M module does not differ between the object manipulation instructions new and change. The instruction new is used also for changing Control-M objects which are already in the ProcMan archive. Thus the instruction change is automatically changed to new by a REST API call. We recommend to use always new, like in the ProcMan dialog.

The value of the process parameter dedicated for the Control-M definition can in the REST API request contain either a Control-M XML/JSON definition string (the XML/JSON must be JSON encoded!), or the string "ctm_import". The second implies, that the Control-M definition is not passed in the request, but shall be imported by the REST API directly from Control-M. Example:

{
    "process": 123,
    "action": "CTM_DEV_TEST_PROD_OPEN",
    "activity_input_data": {
        "complete": true,
        "ignore_missing_checks": true,
        "ticket": {
            "CTM.GNRL.DESCR": "Some description"
        },
        "memo": "Modifications accepted",
        "objects": [
            {
                "instruction": "new",
                "object":
                {
                    "CTM.KEY.SYSTEM": "DEV",
                    "CTM.KEY.SERVER": "CTM_DEV",
                    "CTM.KEY.FOLDER": "DFOLDER#1",
                    "CTM.DATA.DEF": "<?xml version='1.0' encoding='UTF-8' ?>\n<DEFTABLE ...>\n...\n<\/DEFTABLE>"
                }
            },
            {
                "instruction": "new",
                "object":
                {
                    "CTM.KEY.SYSTEM": "DEV",
                    "CTM.KEY.SERVER": "CTM_DEV",
                    "CTM.KEY.FOLDER": "DFOLDER#2",
                    "CTM.DATA.DEF": "ctm_import"
                }
            }
        ]
    }
}