Running workflows

Run a particular workflow.

Before you begin

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

Procedure

  1. In a REST client platform, add the authentication details of the tenant that is associated with the workflow 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 at the URL of the workflow that you want to run.

    URL Syntax - <domain>/apis/v1/rest/projects/:project/workflows/:workflow/run

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

    If the request is successful, you receive the response code for success. 
    {
 output : 
	{
	run_id: <run_id>,
	response: "Workflow enqueue successfully.",
	status: "<current_stauts_of_workflow_run>",
	workflow_uid: <workflow_uid>,
	project_uid: <workflow_project_uid>,
	tenant_uid: <workflow_tenant_uid>
    }
}