Defining an Execution REST API Operation Step

The following procedure describes how to define an Execution operation step for REST API. You can add many Execution operation steps if required.

After completing Execution operation steps you can validate, test and then deploy the job type. For more information about deployment, see Job Type Deployment.

Begin

1. Do the following:

   1. In the Name field, type the name of the operation step.

   2. In the Description field type a description for the step which helps you identify the Execution step.

2. To run the operation step based on a specific event, in the Events field, click and from the drop-down list select the parameters, as described in Event Parameters.

   By default, the operation step only runs if the previous step succeeded. If you want the operation step to run regardless of the result of the previous operation, delete the event by clicking.

3. In the Type field, from the drop-down list ensure that you select REST API.

4. 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.

5. If you want to edit the URL and/or want to add authentication, see Editing a REST API URL.

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 add job completion verification select the Verify operation completion checkbox.

    For more information about Verify operation completion, see Defining a Command Line Job Completion Verification Rule.

11. If you want to attach content to job output do any of the following:

    • To attach the REST API request to Control-M output, select the Append REST API request checkbox.

    • To attach the REST API response to Control-M output, select the Append REST API response checkbox.

    If you want to change job content, from the toolbar, click Job Output Options

12. (Optional) From the Execution operation step, click do one or more of the following:

    • To define how the job runs in the Monitoring domain, click Runtime information capture. For more information, see Defining a Command Line Runtime Data Rule.

    • To define how to stop the job manually, click Manual abort operation. For more information, see Defining a Command Line Manual Abort Operation Rule.

    You can also duplicate, clear content, add or delete a step. If you have created more than one Execution operation step, you can move the priority by clicking Move up or Move down.