New Documentation


Control-M Automation API Documentation has moved to a new location, with a new design to enhance ease of use.

Code Reference

Control-M Automation API enables you to manage jobs through JSON code.

The following topics provide code samples that describe how to define Control-M objects using JSON notation:

Control-M objects in JSON code

Each Control-M object begins with a "Name" and then a "Type" specifier as the first property. All object names are defined in PascalCase notation with first letters in capital case. In the examples below, the "Name" of the object is "ObjectName" and the "Type" is "ObjectType".

	"ObjectName" : {
		"Type" : "ObjectType"

The following object types are the most basic objects in Control-M job management:

Object typeDescription

A container of jobs. The following types of folders are available:

  • Regular folder — Groups together a collection of jobs and enables you to configure definitions at the folder level and have these definitions inherited by the jobs within the folder. For example, you can set schedules and manage events, resources, and notifications at the Folder level, to be applied to all jobs in the folder.
  • SubFolder — A folder nested within another regular folder or subfolder. Subfolders offer many (but not all) of the capabilities that are offered by regular folders.
  • Simple folder — Groups together a collection of jobs. Folder definitions are not inherited by jobs within the folder.

You can use a Flow to define order dependency between jobs in a folder.

JobA business process that you schedule and run in your enterprise environment.
CalendarA set of scheduling criteria that you can apply to multiple jobs (instead of having to define scheduling criteria in each individual job).
Site StandardsA set of rules that enable you to control job definition by enforcing restrictions on job parameters.
Site Standard PoliciesSite Standard Policies enable you to enforce Site Standards on folders.
Connection ProfileAccess methods and security credentials for a specific application that runs jobs for an installed plug-in.
DefaultsDefinitions of default parameter values that you can apply to multiple objects, all at once.

Related information

For more information about Control-M, use the following resources.

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