Services provided by Control-M/EM through Control-M Web Services and Messaging API

The following table describes the services provided by Control-M/EM through Control-M Web Services and Messaging API through the Control-M/EM GUI Server. For more information about the Services provided see Issuing requests and handling responses in Control-M/EM API Guide.

Request type

Description

User Registration

Sends the username and password of the user to the target server component

Check user token validity

Checks if the specified user identification is still valid

Client Keep Alive

Resets the registration timeout counter to zero

User Unregistration

Sends the user token to the server component, which erases the user from its active users list

Create job definitions

Creates or updates a regular folder definition

Create scheduling group definitions

Creates or updates a sub application definition

Create folder definitions

Creates a regular or SMART folder definitions

NOTE: Relevant for Control-M/EM version 8.0.00 and above.

Add jobs to folder definitions

Enables you to add job definitions into an existing folder or sub folder

NOTE: Relevant for Control-M/EM version 8.0.00 and above.

Add folder to folder definitions

Enables you to add sub folder definitions into an existing SMART folder or sub folder.

NOTE: Relevant for Control-M/EM version 8.0.00 and above.

List conditions

Retrieves a list of conditions for a job

NOTE: Relevant for Control-M/EM version 8.0.00 and above.

Delete job definitions

Deletes a regular folder definition

Upload folder

Uploads a folder

Order or Force

Inserts a job or folder into Active Jobs immediately (force) or subject to scheduling criteria (order)

Job creation

Creates a job processing or folder definition and inserts it into Active Jobs

Add Condition

Adds conditions

Delete Condition

Deletes conditions

Job actions in Active Jobs

Performs actions on jobs that are currently active in Active Jobs (Hold, Free, Confirm, Rerun, Kill, Force, OK)

Job tracking

Polls the Response repository in the Control-M/EM GUI Server to receive completion confirmation from earlier job processing requests

Retrieve jobs in Active Jobs

Retrieves jobs that are currently in Active Jobs

Change alert status

Changes the status of an alert (for example, from not_noticed to handled)

Retrieve BIM Services list

Retrieves the list of services active in the BMC Batch Impact Manager Server

Parent Topic

Control-M for Web Services, Java, and Messaging overview