Defining a REST API runtime data rule

This procedure describes how to add REST API runtime data rules to your Execution operation step, which enables you to obtain information when the job runs which appears in the Monitoring domain in Control-M client. You can check the status or obtain information about the job run while it runs. For example, you may want to expose the job's progress.

NOTE: If you want to remove all content from the step or delete the step, from the Runtime Information capture operation step, click and select the option you require.

To add a runtime data rule:

1. From the Execution operation step, click and then click Runtime information capture.
2. In the Type field ensure that you select REST API.

   NOTE: To change the operation type, from the dropdown list select either Web Service or REST API.

3. In the REST API field, click Add REST API URL and do one of the following:
   • To add a new REST API URL see Adding a REST API URL.
   • If already defined, select the REST API URL.
4. If you want to edit the URL and/or want to add authentication, see Editing a REST API URL.
5. In the Method field, from the dropdown list select one of the Methods to be invoked.
6. Type the REST API parameters as described in REST API parameters.
7. In the Advanced Options section, add the options you require, as described in REST API Advanced options.
8. To define how the output should be handled, in the Output Handling field, click.

   For more information about Output Handling rules, see Output handling rules.

9. To attach content to job output do any of the following:
   • To attach the Web Service request to Control-M output, select the Append web service request checkbox.
   • To attach the Web Service response to Control-M output, select the Append web service response checkbox.

   NOTE: You can change job output content for your job type, from the toolbar, by clicking Options.