Diff Workflow Versions

curl --request GET \
  --url https://api.retab.com/v1/workflows/versions/diff \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/workflows/versions/diff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/workflows/versions/diff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/workflows/versions/diff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/workflows/versions/diff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "from_workflow_version_id": "<string>",
  "to_workflow_version_id": "<string>",
  "added_block_ids": [],
  "removed_block_ids": [],
  "changed_block_ids": [],
  "added_edge_ids": [],
  "removed_edge_ids": [],
  "changed_edge_ids": []
}

{
  "detail": []
}

GET

workflows

versions

diff

Diff Workflow Versions

curl --request GET \
  --url https://api.retab.com/v1/workflows/versions/diff \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/workflows/versions/diff', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/workflows/versions/diff",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/workflows/versions/diff"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/workflows/versions/diff")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "from_workflow_version_id": "<string>",
  "to_workflow_version_id": "<string>",
  "added_block_ids": [],
  "removed_block_ids": [],
  "changed_block_ids": [],
  "added_edge_ids": [],
  "removed_edge_ids": [],
  "changed_edge_ids": []
}

{
  "detail": []
}

Compare two immutable workflow graph versions.

Python

from_version_id = "wfv_before"
to_version_id = "wfv_after"
print(from_version_id, to_version_id)

TypeScript

const fromWorkflowVersionId = "wfv_before";
const toWorkflowVersionId = "wfv_after";
console.log(fromWorkflowVersionId, toWorkflowVersionId);

fromWorkflowVersionID := "wfv_before"
toWorkflowVersionID := "wfv_after"
_, _ = fromWorkflowVersionID, toWorkflowVersionID

Java

String fromWorkflowVersionId = "wfv_before";
String toWorkflowVersionId = "wfv_after";
System.out.println(fromWorkflowVersionId + " " + toWorkflowVersionId);

cURL

curl "https://api.retab.com/v1/workflows/versions/diff?workflow_id=wf_abc123&from_workflow_version_id=wfv_before&to_workflow_version_id=wfv_after" \
  -H "Authorization: Bearer $RETAB_API_KEY"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workflow_id

string

required

Workflow whose versions to diff

from_workflow_version_id

string

required

Base workflow version ID

to_workflow_version_id

string

required

Target workflow version ID

Response

Successful Response

from_workflow_version_id

string

required

to_workflow_version_id

string

required

added_block_ids

string[]

removed_block_ids

string[]

changed_block_ids

string[]

added_edge_ids

string[]

removed_edge_ids

string[]

changed_edge_ids

string[]