Defining a REST API job completion verification rule

This procedure describes how to define a REST API job completion verification rule to your Execution operation, which enables you to verify that a job is completed.

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

Before you begin

Ensure that you select Verify operation completion.

To define a job completion verification rule:

1. Type the number of seconds in the Run this step every [n] seconds until the defined completion criteria below is satisfied.
2. In the Type field, ensure that you select REST API.

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

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 you 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. Type the REST API parameters as described in REST API parameters.
6. In the Method field, from the dropdown list select one of the Methods to be invoked.
7. Type the REST API parameters as described in REST API parameters.
8. In the Advanced Options section, add the options you require, as described in REST API Advanced options.
9. 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.

10. If you want to attach content to job output do any of the following:
    • To attach the Web Service request to Control-M output, select the Append REST API request checkbox.
    • To attach the Web Service response to Control-M output, select the Append REST API response checkbox.

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

11. In the Tolerance area, you can select one or more of the following:
    • Retries in case of failure: Type the number of retries and then add parameters where required.
    • Timeout: Type the timeout for this operation in minutes.

      NOTE: Default values: 0. The first job failure causes the step to fail.