Python
from engini import Engini
client = Engini() # reads ENGINI_API_KEY
# the workflow must be turned off
updated = client.workflows.update(1234, plan, expected_revision_id=3)import { Engini } from "@engini/sdk";
const client = new Engini(); // reads ENGINI_API_KEY
// the workflow must be turned off
const updated = await client.workflows.update(1234, { plan, expectedRevisionId: 3 });engini workflows update 1234 --file plan.json --expected-revision-id 3const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan: {
name: '<string>',
trigger: {
key: '<string>',
type: '<string>',
connection: '<string>',
inputs: {},
tool: '<string>',
condition: {left: '<string>', op: '<string>', right: '<string>'},
then: '<array>',
else: '<array>',
items: '<string>',
do: '<array>',
cases: [{value: '<string>', steps: '<array>'}],
default: '<array>',
onFailure: '<array>',
ref: 123,
schedule: {
frequency: '<string>',
interval: 123,
startDate: '<string>',
startTime: '<string>',
weekDays: '<string>',
timeZone: '<string>',
timeFrames: [{start: '<string>', end: '<string>', everyMinutes: 123}]
},
listenColumns: ['<string>'],
filters: [{field: '<string>', operator: '<string>', value: '<string>'}],
top: 123,
sorts: [{field: '<string>', direction: '<string>'}],
advancedFilter: true,
offset: 123,
sample: '<string>',
mapDictionary: true,
subItems: {},
model: {provider: '<string>', connection: '<string>', inputs: {}},
memory: {sessionId: '<string>', windowLength: '<string>'},
tools: [
{
connection: '<string>',
inputs: {},
aiInputs: {},
name: '<string>',
tool: '<string>',
description: '<string>'
}
],
value: '<unknown>',
valueTypes: {}
},
steps: [
{
key: '<string>',
type: '<string>',
connection: '<string>',
inputs: {},
tool: '<string>',
condition: {left: '<string>', op: '<string>', right: '<string>'},
then: '<array>',
else: '<array>',
items: '<string>',
do: '<array>',
cases: [{value: '<string>', steps: '<array>'}],
default: '<array>',
onFailure: '<array>',
ref: 123,
schedule: {
frequency: '<string>',
interval: 123,
startDate: '<string>',
startTime: '<string>',
weekDays: '<string>',
timeZone: '<string>',
timeFrames: [{start: '<string>', end: '<string>', everyMinutes: 123}]
},
listenColumns: ['<string>'],
filters: [{field: '<string>', operator: '<string>', value: '<string>'}],
top: 123,
sorts: [{field: '<string>', direction: '<string>'}],
advancedFilter: true,
offset: 123,
sample: '<string>',
mapDictionary: true,
subItems: {},
model: {provider: '<string>', connection: '<string>', inputs: {}},
memory: {sessionId: '<string>', windowLength: '<string>'},
tools: [
{
connection: '<string>',
inputs: {},
aiInputs: {},
name: '<string>',
tool: '<string>',
description: '<string>'
}
],
value: '<unknown>',
valueTypes: {}
}
],
notes: [
{
id: '<string>',
content: '<string>',
x: 123,
y: 123,
width: 123,
height: 123,
color: '<string>'
}
],
table: '<string>'
},
expectedRevisionId: 123
})
};
fetch('https://api.engini.io/v1/workflows/{workflowId}', 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.engini.io/v1/workflows/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'plan' => [
'name' => '<string>',
'trigger' => [
'key' => '<string>',
'type' => '<string>',
'connection' => '<string>',
'inputs' => [
],
'tool' => '<string>',
'condition' => [
'left' => '<string>',
'op' => '<string>',
'right' => '<string>'
],
'then' => '<array>',
'else' => '<array>',
'items' => '<string>',
'do' => '<array>',
'cases' => [
[
'value' => '<string>',
'steps' => '<array>'
]
],
'default' => '<array>',
'onFailure' => '<array>',
'ref' => 123,
'schedule' => [
'frequency' => '<string>',
'interval' => 123,
'startDate' => '<string>',
'startTime' => '<string>',
'weekDays' => '<string>',
'timeZone' => '<string>',
'timeFrames' => [
[
'start' => '<string>',
'end' => '<string>',
'everyMinutes' => 123
]
]
],
'listenColumns' => [
'<string>'
],
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
],
'top' => 123,
'sorts' => [
[
'field' => '<string>',
'direction' => '<string>'
]
],
'advancedFilter' => true,
'offset' => 123,
'sample' => '<string>',
'mapDictionary' => true,
'subItems' => [
],
'model' => [
'provider' => '<string>',
'connection' => '<string>',
'inputs' => [
]
],
'memory' => [
'sessionId' => '<string>',
'windowLength' => '<string>'
],
'tools' => [
[
'connection' => '<string>',
'inputs' => [
],
'aiInputs' => [
],
'name' => '<string>',
'tool' => '<string>',
'description' => '<string>'
]
],
'value' => '<unknown>',
'valueTypes' => [
]
],
'steps' => [
[
'key' => '<string>',
'type' => '<string>',
'connection' => '<string>',
'inputs' => [
],
'tool' => '<string>',
'condition' => [
'left' => '<string>',
'op' => '<string>',
'right' => '<string>'
],
'then' => '<array>',
'else' => '<array>',
'items' => '<string>',
'do' => '<array>',
'cases' => [
[
'value' => '<string>',
'steps' => '<array>'
]
],
'default' => '<array>',
'onFailure' => '<array>',
'ref' => 123,
'schedule' => [
'frequency' => '<string>',
'interval' => 123,
'startDate' => '<string>',
'startTime' => '<string>',
'weekDays' => '<string>',
'timeZone' => '<string>',
'timeFrames' => [
[
'start' => '<string>',
'end' => '<string>',
'everyMinutes' => 123
]
]
],
'listenColumns' => [
'<string>'
],
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
],
'top' => 123,
'sorts' => [
[
'field' => '<string>',
'direction' => '<string>'
]
],
'advancedFilter' => true,
'offset' => 123,
'sample' => '<string>',
'mapDictionary' => true,
'subItems' => [
],
'model' => [
'provider' => '<string>',
'connection' => '<string>',
'inputs' => [
]
],
'memory' => [
'sessionId' => '<string>',
'windowLength' => '<string>'
],
'tools' => [
[
'connection' => '<string>',
'inputs' => [
],
'aiInputs' => [
],
'name' => '<string>',
'tool' => '<string>',
'description' => '<string>'
]
],
'value' => '<unknown>',
'valueTypes' => [
]
]
],
'notes' => [
[
'id' => '<string>',
'content' => '<string>',
'x' => 123,
'y' => 123,
'width' => 123,
'height' => 123,
'color' => '<string>'
]
],
'table' => '<string>'
],
'expectedRevisionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engini.io/v1/workflows/{workflowId}"
payload := strings.NewReader("{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.engini.io/v1/workflows/{workflowId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engini.io/v1/workflows/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}"
response = http.request(request)
puts response.read_body{
"workflowId": 123,
"revisionId": 123,
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}Workflows
Update a workflow
Send the revisionId read with the plan as expectedRevisionId. Needs a key with a workspace (400 SCOPE_REQUIRED otherwise); the workflow stays turned off.
PUT
/
v1
/
workflows
/
{workflowId}
Python
from engini import Engini
client = Engini() # reads ENGINI_API_KEY
# the workflow must be turned off
updated = client.workflows.update(1234, plan, expected_revision_id=3)import { Engini } from "@engini/sdk";
const client = new Engini(); // reads ENGINI_API_KEY
// the workflow must be turned off
const updated = await client.workflows.update(1234, { plan, expectedRevisionId: 3 });engini workflows update 1234 --file plan.json --expected-revision-id 3const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan: {
name: '<string>',
trigger: {
key: '<string>',
type: '<string>',
connection: '<string>',
inputs: {},
tool: '<string>',
condition: {left: '<string>', op: '<string>', right: '<string>'},
then: '<array>',
else: '<array>',
items: '<string>',
do: '<array>',
cases: [{value: '<string>', steps: '<array>'}],
default: '<array>',
onFailure: '<array>',
ref: 123,
schedule: {
frequency: '<string>',
interval: 123,
startDate: '<string>',
startTime: '<string>',
weekDays: '<string>',
timeZone: '<string>',
timeFrames: [{start: '<string>', end: '<string>', everyMinutes: 123}]
},
listenColumns: ['<string>'],
filters: [{field: '<string>', operator: '<string>', value: '<string>'}],
top: 123,
sorts: [{field: '<string>', direction: '<string>'}],
advancedFilter: true,
offset: 123,
sample: '<string>',
mapDictionary: true,
subItems: {},
model: {provider: '<string>', connection: '<string>', inputs: {}},
memory: {sessionId: '<string>', windowLength: '<string>'},
tools: [
{
connection: '<string>',
inputs: {},
aiInputs: {},
name: '<string>',
tool: '<string>',
description: '<string>'
}
],
value: '<unknown>',
valueTypes: {}
},
steps: [
{
key: '<string>',
type: '<string>',
connection: '<string>',
inputs: {},
tool: '<string>',
condition: {left: '<string>', op: '<string>', right: '<string>'},
then: '<array>',
else: '<array>',
items: '<string>',
do: '<array>',
cases: [{value: '<string>', steps: '<array>'}],
default: '<array>',
onFailure: '<array>',
ref: 123,
schedule: {
frequency: '<string>',
interval: 123,
startDate: '<string>',
startTime: '<string>',
weekDays: '<string>',
timeZone: '<string>',
timeFrames: [{start: '<string>', end: '<string>', everyMinutes: 123}]
},
listenColumns: ['<string>'],
filters: [{field: '<string>', operator: '<string>', value: '<string>'}],
top: 123,
sorts: [{field: '<string>', direction: '<string>'}],
advancedFilter: true,
offset: 123,
sample: '<string>',
mapDictionary: true,
subItems: {},
model: {provider: '<string>', connection: '<string>', inputs: {}},
memory: {sessionId: '<string>', windowLength: '<string>'},
tools: [
{
connection: '<string>',
inputs: {},
aiInputs: {},
name: '<string>',
tool: '<string>',
description: '<string>'
}
],
value: '<unknown>',
valueTypes: {}
}
],
notes: [
{
id: '<string>',
content: '<string>',
x: 123,
y: 123,
width: 123,
height: 123,
color: '<string>'
}
],
table: '<string>'
},
expectedRevisionId: 123
})
};
fetch('https://api.engini.io/v1/workflows/{workflowId}', 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.engini.io/v1/workflows/{workflowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'plan' => [
'name' => '<string>',
'trigger' => [
'key' => '<string>',
'type' => '<string>',
'connection' => '<string>',
'inputs' => [
],
'tool' => '<string>',
'condition' => [
'left' => '<string>',
'op' => '<string>',
'right' => '<string>'
],
'then' => '<array>',
'else' => '<array>',
'items' => '<string>',
'do' => '<array>',
'cases' => [
[
'value' => '<string>',
'steps' => '<array>'
]
],
'default' => '<array>',
'onFailure' => '<array>',
'ref' => 123,
'schedule' => [
'frequency' => '<string>',
'interval' => 123,
'startDate' => '<string>',
'startTime' => '<string>',
'weekDays' => '<string>',
'timeZone' => '<string>',
'timeFrames' => [
[
'start' => '<string>',
'end' => '<string>',
'everyMinutes' => 123
]
]
],
'listenColumns' => [
'<string>'
],
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
],
'top' => 123,
'sorts' => [
[
'field' => '<string>',
'direction' => '<string>'
]
],
'advancedFilter' => true,
'offset' => 123,
'sample' => '<string>',
'mapDictionary' => true,
'subItems' => [
],
'model' => [
'provider' => '<string>',
'connection' => '<string>',
'inputs' => [
]
],
'memory' => [
'sessionId' => '<string>',
'windowLength' => '<string>'
],
'tools' => [
[
'connection' => '<string>',
'inputs' => [
],
'aiInputs' => [
],
'name' => '<string>',
'tool' => '<string>',
'description' => '<string>'
]
],
'value' => '<unknown>',
'valueTypes' => [
]
],
'steps' => [
[
'key' => '<string>',
'type' => '<string>',
'connection' => '<string>',
'inputs' => [
],
'tool' => '<string>',
'condition' => [
'left' => '<string>',
'op' => '<string>',
'right' => '<string>'
],
'then' => '<array>',
'else' => '<array>',
'items' => '<string>',
'do' => '<array>',
'cases' => [
[
'value' => '<string>',
'steps' => '<array>'
]
],
'default' => '<array>',
'onFailure' => '<array>',
'ref' => 123,
'schedule' => [
'frequency' => '<string>',
'interval' => 123,
'startDate' => '<string>',
'startTime' => '<string>',
'weekDays' => '<string>',
'timeZone' => '<string>',
'timeFrames' => [
[
'start' => '<string>',
'end' => '<string>',
'everyMinutes' => 123
]
]
],
'listenColumns' => [
'<string>'
],
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
],
'top' => 123,
'sorts' => [
[
'field' => '<string>',
'direction' => '<string>'
]
],
'advancedFilter' => true,
'offset' => 123,
'sample' => '<string>',
'mapDictionary' => true,
'subItems' => [
],
'model' => [
'provider' => '<string>',
'connection' => '<string>',
'inputs' => [
]
],
'memory' => [
'sessionId' => '<string>',
'windowLength' => '<string>'
],
'tools' => [
[
'connection' => '<string>',
'inputs' => [
],
'aiInputs' => [
],
'name' => '<string>',
'tool' => '<string>',
'description' => '<string>'
]
],
'value' => '<unknown>',
'valueTypes' => [
]
]
],
'notes' => [
[
'id' => '<string>',
'content' => '<string>',
'x' => 123,
'y' => 123,
'width' => 123,
'height' => 123,
'color' => '<string>'
]
],
'table' => '<string>'
],
'expectedRevisionId' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.engini.io/v1/workflows/{workflowId}"
payload := strings.NewReader("{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.engini.io/v1/workflows/{workflowId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engini.io/v1/workflows/{workflowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan\": {\n \"name\": \"<string>\",\n \"trigger\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n },\n \"steps\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"tool\": \"<string>\",\n \"condition\": {\n \"left\": \"<string>\",\n \"op\": \"<string>\",\n \"right\": \"<string>\"\n },\n \"then\": \"<array>\",\n \"else\": \"<array>\",\n \"items\": \"<string>\",\n \"do\": \"<array>\",\n \"cases\": [\n {\n \"value\": \"<string>\",\n \"steps\": \"<array>\"\n }\n ],\n \"default\": \"<array>\",\n \"onFailure\": \"<array>\",\n \"ref\": 123,\n \"schedule\": {\n \"frequency\": \"<string>\",\n \"interval\": 123,\n \"startDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"weekDays\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"timeFrames\": [\n {\n \"start\": \"<string>\",\n \"end\": \"<string>\",\n \"everyMinutes\": 123\n }\n ]\n },\n \"listenColumns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"top\": 123,\n \"sorts\": [\n {\n \"field\": \"<string>\",\n \"direction\": \"<string>\"\n }\n ],\n \"advancedFilter\": true,\n \"offset\": 123,\n \"sample\": \"<string>\",\n \"mapDictionary\": true,\n \"subItems\": {},\n \"model\": {\n \"provider\": \"<string>\",\n \"connection\": \"<string>\",\n \"inputs\": {}\n },\n \"memory\": {\n \"sessionId\": \"<string>\",\n \"windowLength\": \"<string>\"\n },\n \"tools\": [\n {\n \"connection\": \"<string>\",\n \"inputs\": {},\n \"aiInputs\": {},\n \"name\": \"<string>\",\n \"tool\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"value\": \"<unknown>\",\n \"valueTypes\": {}\n }\n ],\n \"notes\": [\n {\n \"id\": \"<string>\",\n \"content\": \"<string>\",\n \"x\": 123,\n \"y\": 123,\n \"width\": 123,\n \"height\": 123,\n \"color\": \"<string>\"\n }\n ],\n \"table\": \"<string>\"\n },\n \"expectedRevisionId\": 123\n}"
response = http.request(request)
puts response.read_body{
"workflowId": 123,
"revisionId": 123,
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"errorCode": "<string>",
"message": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"details": [
{
"field": "<string>",
"issue": "<string>"
}
]
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}{
"status": 123,
"code": "<string>",
"message": "<string>",
"path": "<string>",
"fix": "<string>",
"diagnostics": [
{
"severity": "<string>",
"code": "<string>",
"message": "<string>",
"stepKey": "<string>",
"field": "<string>"
}
],
"currentRevisionId": 123
}Body
application/json
The plan, as JSON.
Response
Success.