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 example below, the "Name" of the object is "ObjectName" and the "Type" is "ObjectType":

Copy

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

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

Object Type	Description
Folder	A container of jobs. The following types of folders are available: 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 folder or sub-folder. Sub-folders offer many (but not all) of the capabilities that are offered by folders. Simple Folder: Groups together a collection of jobs. Folder definitions are not inherited by jobs within the simple folder. In addition, you can use a Flow to define order dependency between jobs in a folder.
Job Properties	A business process that you schedule and run in your enterprise environment.
Calendars	A set of scheduling criteria that you can apply to multiple jobs (instead of having to define scheduling criteria in each individual job).
Site Standards	A set of rules that enable you to control job definition by enforcing restrictions on job parameters.
Site Standard Policies	Enables you to enforce Site Standards on folders.
Connection Profiles	Access methods and security credentials for a specific application that runs jobs for an installed plug-in.
Defaults	Definitions of default parameter values that you can apply to multiple objects all at once.