Running flow services

Run a particular Flow service.

Before you begin

Verify that you have the write and run access specifically for the project where you intend to run the flow service.

Procedure

  1. In a REST client platform, add the authentication details of the tenant that is associated with the flow service you want to run.
    
    //In case of Instance API key 
    Headers:
    {
    "x-instance-api-key": "instance_api_key"
    }
     
    // In case of MCSP or ISV token
    Headers:
    {
    "Authorization": "mcsp_or_isv_token"
    }
  2. Make a POST request to the Flow service URL.

    URL Syntax - <domain>/apis/v1/rest/projects/:project/flows/:flow/run

    In this URL request, /:project is the name of the project that is associated with the flow service you want to run. /:flow is the name of the flow service that you want to run.

    If the request is successful, you receive the response code for success.
    {
    output : 
    	{
    	"contentStream": "<content_stream>",
        "date": "<datetime>"
        }
    }