Start a workflow

Use code to start a workflow and submit a form.

Overview

Starting a workflow involves three steps.

Initialize the workflow
Get the draft document id
Submit the document with data to the workflow

To simplify things, the example below uses a very simple form with only one field. A typical form will have much more data involved, but the process will still be these three steps, just with more data in the submit document step.

Step 1: Initialize the workflow

Call the initializeWorkflow mutation to start the workflow and get the actionId for the workflow you started.

Query

      
        mutation ($appId: ID!) {
  initializeWorkflow(args: {id: $appId}) {
    actionId
  }
}

      
        curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"mutation ($appId: ID!) { initializeWorkflow(args: {id: $appId}) { actionId }}","variables":{
  "appId": "63e2d5339ed71b32ade73a42"
}}' --compressed

      
        import fetch from 'node-fetch'

const subdomain = 'subdomain'
const apikey = 'apikey'

const query = `mutation ($appId: ID!) {
                 initializeWorkflow(args: {id: $appId}) {
                   actionId
                 }
               }`

const variables = {
  "appId": "63e2d5339ed71b32ade73a42"
}


fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
  method:'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${apikey}`
  },
  body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))

      
        <?php

$subdomain = "subdomain";
$apikey = "apikey";

$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$data= '{"query":"mutation ($appId: ID!) { initializeWorkflow(args: {id: $appId}) { actionId }}","variables":{
  "appId": "63e2d5339ed71b32ade73a42"
}}';

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

          
          require 'net/http'
require 'uri'
require 'json'

subdomain = "subdomain"
apikey = "apikey"

uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
  "query" => "mutation ($appId: ID!) {
                initializeWorkflow(args: {id: $appId}) {
                  actionId
                }
              }",
  "variables" => {
    "appId": "63e2d5339ed71b32ade73a42"
  }
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

puts response.code
puts response.body

          
          import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;

public class exampleCreate {
  public static void main(String[] args) throws IOException {
    String subdomain = "subdomain";
    String apikey = "apikey";

    URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
    HttpURLConnection http = (HttpURLConnection)url.openConnection();
    http.setRequestMethod("POST");
    http.setDoOutput(true);
    http.setRequestProperty("Content-Type", "application/json");
    http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
    http.setRequestProperty("Authorization", "Bearer " + apikey);

    String data = "{\"query\":\"mutation ($appId: ID!) { initializeWorkflow(args: {id: $appId}) { actionId }}\",\"variables\":{\"appId\":\"63e2d5339ed71b32ade73a42\"}}";

    byte[] out = data.getBytes(Charset.forName("UTF-8"));

    OutputStream stream = http.getOutputStream();
    stream.write(out);
    System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
    BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    //print in String
    System.out.println(response.toString());
    http.disconnect();
  }
}

Variables

      
{
  "appId": "63e2d5339ed71b32ade73a42"
}

Results

      
        {
          "data": {
            "initializeWorkflow": {
              "actionId": "6402959d200606e80fe6f20d"
            }
          }
        }

Step 2: Get the draft document id

When the workflow is initiated it creates an empty draft of a document. We need the id of that document in order to give it data and submit it to the workflow. Note: We pass the actionId from the initializeWorkflow operation as a variable here.

Query

      
        query ($actionId: String!) {
  action(actionId: $actionId) {
    id
    appId
    document {
      id
    }
  }
}

      
        curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"query ($actionId: String!) { action(actionId: $actionId) { id appId document { id } }}","variables":{
  "actionId": "6402959d200606e80fe6f20d"
}}' --compressed

      
        import fetch from 'node-fetch'

const subdomain = 'subdomain'
const apikey = 'apikey'

const query = `query ($actionId: String!) {
                 action(actionId: $actionId) {
                   id
                   appId
                   document {
                     id
                   }
                 }
               }`

const variables = {
  "actionId": "6402959d200606e80fe6f20d"
}


fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
  method:'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${apikey}`
  },
  body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))

      
        <?php

$subdomain = "subdomain";
$apikey = "apikey";

$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$data= '{"query":"query ($actionId: String!) { action(actionId: $actionId) { id appId document { id } }}","variables":{
  "actionId": "6402959d200606e80fe6f20d"
}}';

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

          
          require 'net/http'
require 'uri'
require 'json'

subdomain = "subdomain"
apikey = "apikey"

uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
  "query" => "query ($actionId: String!) {
                action(actionId: $actionId) {
                  id
                  appId
                  document {
                    id
                  }
                }
              }",
  "variables" => {
    "actionId": "6402959d200606e80fe6f20d"
  }
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

puts response.code
puts response.body

          
          import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;

public class exampleCreate {
  public static void main(String[] args) throws IOException {
    String subdomain = "subdomain";
    String apikey = "apikey";

    URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
    HttpURLConnection http = (HttpURLConnection)url.openConnection();
    http.setRequestMethod("POST");
    http.setDoOutput(true);
    http.setRequestProperty("Content-Type", "application/json");
    http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
    http.setRequestProperty("Authorization", "Bearer " + apikey);

    String data = "{\"query\":\"query ($actionId: String!) { action(actionId: $actionId) { id appId document { id } }}\",\"variables\":{\"actionId\":\"6402959d200606e80fe6f20d\"}}";

    byte[] out = data.getBytes(Charset.forName("UTF-8"));

    OutputStream stream = http.getOutputStream();
    stream.write(out);
    System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
    BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    //print in String
    System.out.println(response.toString());
    http.disconnect();
  }
}

Variables

      
{
  "actionId": "6402959d200606e80fe6f20d"
}

Results

      
        {
          "data": {
            "action": {
              "id": "6402959d200606e80fe6f20d",
              "appId": "63e2d5339ed71b32ade73a42",
              "document": {
                "id": "64029dab6f0562f58f91a206"
              }
            }
          }
        }

Step 3: Submit the document

Now we submit the document with the data and the workflow moves to the first step and is fully started. Note that we pass the status as completed to tell the workflow that the first step of submitting the document is complete.

Query

      
        mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) {
  submitDocument(
    id: $documentId
    data: $data
    actionId: $actionId
    status: $status
  )
}

      
        curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) { submitDocument( id: $documentId data: $data actionId: $actionId status: $status )}","variables":{
  "documentId": "64029dab6f0562f58f91a206",
  "data": {
    "dORA8YYBmX": "English 450"
  },
  "actionId": "6402959d200606e80fe6f20d",
  "status": "completed"
}}' --compressed

      
        import fetch from 'node-fetch'

const subdomain = 'subdomain'
const apikey = 'apikey'

const query = `mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) {
                 submitDocument(
                   id: $documentId
                   data: $data
                   actionId: $actionId
                   status: $status
                 )
               }`

const variables = {
  "documentId": "64029dab6f0562f58f91a206",
  "data": {
    "dORA8YYBmX": "English 450"
  },
  "actionId": "6402959d200606e80fe6f20d",
  "status": "completed"
}


fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
  method:'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${apikey}`
  },
  body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))

      
        <?php

$subdomain = "subdomain";
$apikey = "apikey";

$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
  "Content-Type: application/json",
  "Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$data= '{"query":"mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) { submitDocument( id: $documentId data: $data actionId: $actionId status: $status )}","variables":{
  "documentId": "64029dab6f0562f58f91a206",
  "data": {
    "dORA8YYBmX": "English 450"
  },
  "actionId": "6402959d200606e80fe6f20d",
  "status": "completed"
}}';

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

          
          require 'net/http'
require 'uri'
require 'json'

subdomain = "subdomain"
apikey = "apikey"

uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
  "query" => "mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) {
                submitDocument(
                  id: $documentId
                  data: $data
                  actionId: $actionId
                  status: $status
                )
              }",
  "variables" => {
    "documentId": "64029dab6f0562f58f91a206",
    "data": {
      "dORA8YYBmX": "English 450"
    },
    "actionId": "6402959d200606e80fe6f20d",
    "status": "completed"
  }
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

puts response.code
puts response.body

          
          import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;

public class exampleCreate {
  public static void main(String[] args) throws IOException {
    String subdomain = "subdomain";
    String apikey = "apikey";

    URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
    HttpURLConnection http = (HttpURLConnection)url.openConnection();
    http.setRequestMethod("POST");
    http.setDoOutput(true);
    http.setRequestProperty("Content-Type", "application/json");
    http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
    http.setRequestProperty("Authorization", "Bearer " + apikey);

    String data = "{\"query\":\"mutation ($documentId: ID!, $data: JSON, $actionId: ID!, $status: String) { submitDocument( id: $documentId data: $data actionId: $actionId status: $status )}\",\"variables\":{\"documentId\":\"64029dab6f0562f58f91a206\",\"data\":{\"dORA8YYBmX\":\"English450\"},\"actionId\":\"6402959d200606e80fe6f20d\",\"status\":\"completed\"}}";

    byte[] out = data.getBytes(Charset.forName("UTF-8"));

    OutputStream stream = http.getOutputStream();
    stream.write(out);
    System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
    BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    //print in String
    System.out.println(response.toString());
    http.disconnect();
  }
}

Variables

      
{
  "documentId": "64029dab6f0562f58f91a206",
  "data": {
    "dORA8YYBmX": "English 450"
  },
  "actionId": "6402959d200606e80fe6f20d",
  "status": "completed"
}

Results

      
        {
          "data": {
            "submitDocument": "Ok"
          }
        }