Run action in API Task package

The Run action in API Task package enables you to invoke a child API Task. The action contains options to assign input values to the child API Task and save the response data of the child API Task in appropriate variables.

Overview

The Run action invokes an API Task available in the Control Room repository. Once selected, the input variables of the child API Task auto-populate in the Input values field.

Note: When you create variables for the child API Task, ensure that you enable the Use as input option to tag the variable as input. Only the variables with Use as input option enabled appear in the Input values field.

You can then add appropriate values for the variables for the child API Task for execution. The Save the outcome to a variable option saves the response data of the child API Task in appropriate variables.

Settings

The Run contains the following settings:

API Task
Specifies the child API Task to invoke. Use the Choose button to select any API Task that is available in the Control Room repositories (both public and private).
The Choose button has a drop-down caret that contains + Create new option. This option enables you to create a new API Task on the go. The Create API Task appears and you can create a new API Task as per your requirements.
Input values
Specifies the required input values for the child API Task.
Save the outcome to a variable
Specifies the variable in which the action saves the response data of the child API Task. Use one of the following option to assign the output data:
  • Multiple variables: Create and specify individual variables to store specific response data.

    Use the Add variable mapping option to specify the key and corresponding variable type to store the specific response data.

  • Dictionary: Create and specify a dictionary variable to store the entire response data. You can also select an existing dictionary variable.