Defining a Pre-Execution REST API Operation Step

The following procedure describes how to define a Pre-Execution operation step for REST API. You can add only one Pre-Execution operation.

If you want to remove all content from the step, in the Pre-Execution operation step, click and select Clear content.

Begin

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

3. In the Type field, ensure that you select REST API.

   To change the operation type, from the drop-down list select either Command Line or Web Service.

4. In the REST API area, 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.

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

6. In the Method field, from the drop-down 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 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.

    You can change job output content for your job type by clicking Job Output Options.