from retab import Retab
client = Retab()
block = client.workflows.blocks.create_version_restore("bkv_abc123")
print(block)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const block = await client.workflows.blocks.create_version_restore("bkv_abc123");
console.log(block);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
block, err := client.Workflows.Blocks.CreateVersionRestore(ctx, "bkv_abc123")
if err != nil {
log.Fatal(err)
}
fmt.Println(*block)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
block = client.workflows.blocks.create_version_restore(block_version_id: 'bkv_abc123')
puts block
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let block = client
.workflows()
.blocks()
.create_version_restore("bkv_abc123")
.await?;
println!("{:?}", block);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$block = $client->workflows()->blocks()->createVersionRestore(
blockVersionId: 'bkv_abc123',
);
print_r($block);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var block = await client.Workflows.Blocks.CreateVersionRestoreAsync("bkv_abc123");
Console.WriteLine(block);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var block = client.workflows().blocks().createVersionRestore("bkv_abc123");
System.out.println(block);
}
}
curl -X POST "https://api.retab.com/v1/workflows/blocks/versions/bkv_abc123/restore?workflow_id=wf_abc123" \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "<string>",
"workflow_id": "<string>",
"type": "start_document",
"updated_at": "2023-11-07T05:31:56Z",
"label": "",
"position_x": 0,
"position_y": 0,
"width": 123,
"height": 123,
"config": {},
"parent_id": "<string>",
"declarative_path": "<string>",
"declarative_source_block_id": "<string>",
"resolved_schemas": {}
}{
"detail": []
}Versions
Restore Block Version
POST
/
v1
/
workflows
/
blocks
/
versions
/
{block_version_id}
/
restore
from retab import Retab
client = Retab()
block = client.workflows.blocks.create_version_restore("bkv_abc123")
print(block)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const block = await client.workflows.blocks.create_version_restore("bkv_abc123");
console.log(block);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
block, err := client.Workflows.Blocks.CreateVersionRestore(ctx, "bkv_abc123")
if err != nil {
log.Fatal(err)
}
fmt.Println(*block)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
block = client.workflows.blocks.create_version_restore(block_version_id: 'bkv_abc123')
puts block
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let block = client
.workflows()
.blocks()
.create_version_restore("bkv_abc123")
.await?;
println!("{:?}", block);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$block = $client->workflows()->blocks()->createVersionRestore(
blockVersionId: 'bkv_abc123',
);
print_r($block);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var block = await client.Workflows.Blocks.CreateVersionRestoreAsync("bkv_abc123");
Console.WriteLine(block);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var block = client.workflows().blocks().createVersionRestore("bkv_abc123");
System.out.println(block);
}
}
curl -X POST "https://api.retab.com/v1/workflows/blocks/versions/bkv_abc123/restore?workflow_id=wf_abc123" \
-H "Authorization: Bearer $RETAB_API_KEY"
{
"id": "<string>",
"workflow_id": "<string>",
"type": "start_document",
"updated_at": "2023-11-07T05:31:56Z",
"label": "",
"position_x": 0,
"position_y": 0,
"width": 123,
"height": 123,
"config": {},
"parent_id": "<string>",
"declarative_path": "<string>",
"declarative_source_block_id": "<string>",
"resolved_schemas": {}
}{
"detail": []
}Restore a workflow block version into the current workflow draft.
from retab import Retab
client = Retab()
block = client.workflows.blocks.create_version_restore("bkv_abc123")
print(block)
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const block = await client.workflows.blocks.create_version_restore("bkv_abc123");
console.log(block);
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
block, err := client.Workflows.Blocks.CreateVersionRestore(ctx, "bkv_abc123")
if err != nil {
log.Fatal(err)
}
fmt.Println(*block)
}
require 'retab'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
block = client.workflows.blocks.create_version_restore(block_version_id: 'bkv_abc123')
puts block
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let block = client
.workflows()
.blocks()
.create_version_restore("bkv_abc123")
.await?;
println!("{:?}", block);
Ok(())
}
<?php
require 'vendor/autoload.php';
use Retab\Client;
$client = new Client(apiKey: getenv('RETAB_API_KEY'));
$block = $client->workflows()->blocks()->createVersionRestore(
blockVersionId: 'bkv_abc123',
);
print_r($block);
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var block = await client.Workflows.Blocks.CreateVersionRestoreAsync("bkv_abc123");
Console.WriteLine(block);
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var block = client.workflows().blocks().createVersionRestore("bkv_abc123");
System.out.println(block);
}
}
curl -X POST "https://api.retab.com/v1/workflows/blocks/versions/bkv_abc123/restore?workflow_id=wf_abc123" \
-H "Authorization: Bearer $RETAB_API_KEY"
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
Public live workflow block object.
Foreign key to workflow
Block type (extract, parse, classifier, etc.)
Available options:
start_document, start_json, note, parse, edit, extract, split, classifier, conditional, api_call, function, while_loop, for_each, merge_dicts, while_loop_sentinel_start, while_loop_sentinel_end, for_each_sentinel_start, for_each_sentinel_end Display label for the block
X position on canvas
Y position on canvas
Block width for resizable blocks
Block height for resizable blocks
Block-specific configuration
ID of parent container (while_loop, for_each)
Canonical declarative block path used to reconcile imported specs.
Authored declarative block id before import-time id regeneration.
Schemas resolved for this block from the workflow graph.