REST API Operation Steps

A REST API operation step enables you to build the job type through a REST API. The following topics describe how to define and delete pre-execution, execution and post-execution command line operation:

• Defining a Pre-Execution REST API Operation Step

• Defining an Execution REST API Operation Step

• Defining a Post-Execution REST API Operation Step

You can edit an Execution operation step by clicking the Execution operation step and editing as required. If you want to delete an operation step, click next to the Operation step that you want to delete and click Delete. If you have created parameters and want to delete them, you need to manually delete them from the Designer area.

After adding a REST API URL, you can edit the URL, add parameters and authentication such as OAuth 2.0. For more information see Editing a REST API URL.

When adding a REST API operation step for the first time, the following fields are added to the Connection Profile view in the Designer area:

• Host: Defines the name of the REST Host.

• Port: Defines the REST port.

• UserName: Defines the name of the user.

• Password: Defines the password for REST.

For a REST Execution operation step, you can add execution steps which are added sequentially in the order that they are inputted, although you can add, remove and reorder the steps. For each operation you can define how the REST API web service operation response should be handled. For more information, see Output Handling Rules.

When defining an Execution operation, you can add the following:

• Output Handling Rules: Enables you to execute an operation step during the job run to retrieve progress and status from the application.

• Manual Abort Operation Rules: Enables you define another operation step to be performed when the Control-M job is requested to be killed.

• Job Completion Verification Rules: Enables you to define the operation step to run to identify job completion.