Control-M Web Services and Messaging API Deprecation

5 October 2023: BMC is alerting you to a change in support, in accordance with the BMC Software Product Support Policy.

As of version 9.0.21, Control-M Automation API enables you to perform services or commands that are equivalent to most of the Web Services and Messaging APIs.

Therefore, as of 1 November 2023, Control-M Web Services and Messaging API is deprecated. This product is no longer enhanced, but Control-M Web Services and Messaging API is fully supported until version 9.0.22 (released no earlier than February 2025). This change does not impact the Control-M for Web Services, Java, and Messaging plug-in.

The following table lists the Control-M Web Services and Messaging APIs and their Control-M Automation API equivalents. 

ActionDeprecated Control-M/EM APIsAutomation API Equivalent
User Registration

request_register

environment add
Check User Token Validity

request_check_user_token

N/A

Client Keep Alive

request_client_keep_alive

N/A
User Unregistration

request_unregister

N/A
Create Folder Definitions

request_def_create_folder

deploy

Add Jobs to Folder Definitions

request_def_add_jobs

deploy

Add Folder to Folder Definitions 

request_def_add_folder

deploy

List Conditions

request_list_conditions

run events::get

Delete Job Definitions

request_def_delete_jobs

deploy job::delete

Upload Folder

request_def_upload_folder

deploy

Order or Force

request_order_force

request_poll_order_force

run order

Job Creation

request_create_aj

request_poll_create_aj

create_job

Note

BMC plans to provide an equivalent run ondemand command that is currently scheduled for release in the first quarter of 2024.

Add Condition

request_add_condition

request_poll_add_condition

run event::add

Delete Condition

request_delete_condition

request_poll_delete_condition

run event::delete

Job Actions in Active Jobs

request_aj_free

request_aj_hold

request_aj_confirm

request_aj_rerun

request_aj_kill

request_aj_set_to_ok

run job::free

run job::hold

run job::confirm

run job::rerun

run job::kill

run job::setToOk

Job Tracking

request_job_track

run job:status::get

Retrieve Jobs from the Active Jobs Database

request_act_retrieve_jobs

run jobs:status::get

Change Alert Status

request_change_alert_status

run alerts:status::update

Retrieve SLA Management Services List

request_get_bim_services_info

run services:sla::get

Was this page helpful? Yes No Submitting... Thank you

Comments