Running a taskflow as an API

To run a taskflow as an API, you must first publish the taskflow as a service. You can then run the taskflow.

When you publish a taskflow, Data Integration generates the service URL and the SOAP service URL. You can use these endpoint URLs to run the taskflow as an API. When you run a taskflow as an API, you can dynamically provide input parameters for the tasks that the taskflow contains and perform orchestration.

NOTE: When you run a taskflow from the taskflow designer or associate a taskflow with a schedule, the taskflow is published. Data Integration generates the service URL and the SOAP service URL.
If you edit a published taskflow, you must publish the taskflow again for the changes to get reflected in the taskflow API.

To disable a taskflow API that was published as a service, you must unpublish the taskflow. After you make the necessary changes, publish the taskflow again for the changes to get reflected in the taskflow API.

  1. In Data Integration, select Explore.
    The Explore page opens.
  2. Navigate to the taskflow that you want to publish as a service and click Actions.
  3. On the Actions menu, click Publish as shown in the following image:

STEP RESULT
Data Integration publishes the taskflow as a service.
NOTE: To unpublish the taskflow, click Unpublish on the Actions menu.

  1. On the Actions menu, click Properties Detail.
    STEP RESULT
    The Properties Detail dialog box appears displaying the service URL and the SOAP service URL as shown in the following image:

The service URL uses the following format:

<Informatica Intelligent Cloud Services URL>/active-bpel/rt/<API_name>

The SOAP service URL uses the following format:

<Informatica Intelligent Cloud Services URL>/active-bpel/soap/<API_name>

You can also view the associated Swagger file and WSDL file.

  1. To run the taskflow, perform one of the following steps based on the type of client that you want to use:
  • If you use a REST client, use the service URL and the API definition available in the Swagger file to send a request through the REST client.
  • If you use a SOAP client, use the SOAP service URL and the API definition available in the WSDL file to send a request through the SOAP client.
    STEP RESULT
    You receive the taskflow run ID as the response.
  1. To monitor the taskflow with the run ID, perform one of the following steps:
    Use the run ID to monitor the taskflow run in the My Jobs page. The instance name uses the following format:
<taskflow name>-<run ID>

Use the status resource to query the status of the taskflow based on the run ID. For more information about using the status resource, see Monitoring taskflow status with the status resource.