How to configure the RESTService activity

Open or Create Workflow: Start by opening your existing workflow or creating a new workflow.

Select Trigger: Select "REST Service" as the trigger option to initiate the workflow.

Define Parameter: Define the parameters for your REST service. This involves specifying the path to which the HTTP POST request will be sent and configuring the headers for the request.

Configure Activity: Configure the HTTP POST request activity by providing the necessary details such as the path, headers, path parameters, Query Parameters, Media Type and Output.

Step 06: Publish Workflow

  1. After completing configuration, publish the workflow.

  2. Provide a version comment (e.g., "Version 1").

Step 07: Deploy the Workflow

After publishing, deploy your workflow to make it active and available for use.

  • Click on the "Deploy" button located in the top-right corner.

  • After clicking the "Deploy" button, a dialog box will appear on your screen.

  • This dialog box prompts you to specify deployment details such as:

    • Selected Workflow: Provide a name for the deployed workflow.

    • Deployment Name: Enter the deployment name.

    • Environment: Choose the environment in which the workflow will be deployed (e.g., development, production).

    • Version: Specify the version of the workflow to be deployed.

  • Click "Deploy " to deploy the workflow.

After successful deployment, a success message will be displayed.

  • The message will contain information such as version, build date, server URL, environment, and status.

  • Click on the "Promote" button to proceed.

Step 08: Test the Workflow

  • Access the test page to verify the functionality of the deployed API.

Use the API testing feature to paste the request URL and configure authentication, parameters, headers, key, value, and body as needed.

  • Test the API to ensure it works as expected.

Last updated