Create an immutable Workflow version using the immediately preceding matching test receipt and unchanged draft
curl --request POST \
--url http://api.den.local/v1/workflows/{configObjectId}/versions \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"code": "<string>",
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"receiptId": "<string>",
"description": "<string>",
"exampleInput": "<unknown>",
"inputSchema": "<unknown>",
"outputSchema": "<unknown>"
}
'import requests
url = "http://api.den.local/v1/workflows/{configObjectId}/versions"
payload = {
"name": "<string>",
"code": "<string>",
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"receiptId": "<string>",
"description": "<string>",
"exampleInput": "<unknown>",
"inputSchema": "<unknown>",
"outputSchema": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
code: '<string>',
requiredCapabilities: [{capabilityName: '<string>', scriptPath: '<string>'}],
receiptId: '<string>',
description: '<string>',
exampleInput: '<unknown>',
inputSchema: '<unknown>',
outputSchema: '<unknown>'
})
};
fetch('http://api.den.local/v1/workflows/{configObjectId}/versions', 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 => "http://api.den.local/v1/workflows/{configObjectId}/versions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'code' => '<string>',
'requiredCapabilities' => [
[
'capabilityName' => '<string>',
'scriptPath' => '<string>'
]
],
'receiptId' => '<string>',
'description' => '<string>',
'exampleInput' => '<unknown>',
'inputSchema' => '<unknown>',
'outputSchema' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://api.den.local/v1/workflows/{configObjectId}/versions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://api.den.local/v1/workflows/{configObjectId}/versions")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/workflows/{configObjectId}/versions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"pluginId": "<string>",
"configObjectId": "<string>",
"title": "<string>",
"description": "<string>",
"canRun": true,
"canManage": true,
"currentVersion": {
"id": "<string>",
"code": "<string>",
"inputSchema": null,
"outputSchema": null,
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"codeDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"automationReferences": [
{
"id": "<string>",
"name": "<string>",
"state": "active",
"configObjectVersionId": "<string>",
"input": "<unknown>"
}
],
"exampleInput": null
},
"versions": [
{
"id": "<string>",
"code": "<string>",
"inputSchema": null,
"outputSchema": null,
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"codeDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"automationReferences": [
{
"id": "<string>",
"name": "<string>",
"state": "active",
"configObjectVersionId": "<string>",
"input": "<unknown>"
}
],
"exampleInput": null
}
],
"latestSnapshot": {
"receiptId": "<string>",
"pluginId": "<string>",
"configObjectId": "<string>",
"configObjectVersionId": "<string>",
"automationRunId": "<string>",
"value": null,
"markdown": "<string>",
"codeDigest": "<string>",
"resultDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"rendererVersion": "codemode-markdown-v1",
"status": "succeeded",
"errorKind": "<string>",
"errorMessage": "<string>",
"source": "manual",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"contentDeletedAt": "2023-11-07T05:31:56Z"
},
"latestSuccessfulSnapshot": {
"receiptId": "<string>",
"pluginId": "<string>",
"configObjectId": "<string>",
"configObjectVersionId": "<string>",
"automationRunId": "<string>",
"value": null,
"markdown": "<string>",
"codeDigest": "<string>",
"resultDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"rendererVersion": "codemode-markdown-v1",
"status": "succeeded",
"errorKind": "<string>",
"errorMessage": "<string>",
"source": "manual",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"contentDeletedAt": "2023-11-07T05:31:56Z"
},
"freshness": {
"state": "never_run"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}Workflows
Create an immutable Workflow version using the immediately preceding matching test receipt and unchanged draft
POST
/
v1
/
workflows
/
{configObjectId}
/
versions
Create an immutable Workflow version using the immediately preceding matching test receipt and unchanged draft
curl --request POST \
--url http://api.den.local/v1/workflows/{configObjectId}/versions \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"code": "<string>",
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"receiptId": "<string>",
"description": "<string>",
"exampleInput": "<unknown>",
"inputSchema": "<unknown>",
"outputSchema": "<unknown>"
}
'import requests
url = "http://api.den.local/v1/workflows/{configObjectId}/versions"
payload = {
"name": "<string>",
"code": "<string>",
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"receiptId": "<string>",
"description": "<string>",
"exampleInput": "<unknown>",
"inputSchema": "<unknown>",
"outputSchema": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
code: '<string>',
requiredCapabilities: [{capabilityName: '<string>', scriptPath: '<string>'}],
receiptId: '<string>',
description: '<string>',
exampleInput: '<unknown>',
inputSchema: '<unknown>',
outputSchema: '<unknown>'
})
};
fetch('http://api.den.local/v1/workflows/{configObjectId}/versions', 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 => "http://api.den.local/v1/workflows/{configObjectId}/versions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'code' => '<string>',
'requiredCapabilities' => [
[
'capabilityName' => '<string>',
'scriptPath' => '<string>'
]
],
'receiptId' => '<string>',
'description' => '<string>',
'exampleInput' => '<unknown>',
'inputSchema' => '<unknown>',
'outputSchema' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://api.den.local/v1/workflows/{configObjectId}/versions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("http://api.den.local/v1/workflows/{configObjectId}/versions")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/workflows/{configObjectId}/versions")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"requiredCapabilities\": [\n {\n \"capabilityName\": \"<string>\",\n \"scriptPath\": \"<string>\"\n }\n ],\n \"receiptId\": \"<string>\",\n \"description\": \"<string>\",\n \"exampleInput\": \"<unknown>\",\n \"inputSchema\": \"<unknown>\",\n \"outputSchema\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"pluginId": "<string>",
"configObjectId": "<string>",
"title": "<string>",
"description": "<string>",
"canRun": true,
"canManage": true,
"currentVersion": {
"id": "<string>",
"code": "<string>",
"inputSchema": null,
"outputSchema": null,
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"codeDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"automationReferences": [
{
"id": "<string>",
"name": "<string>",
"state": "active",
"configObjectVersionId": "<string>",
"input": "<unknown>"
}
],
"exampleInput": null
},
"versions": [
{
"id": "<string>",
"code": "<string>",
"inputSchema": null,
"outputSchema": null,
"requiredCapabilities": [
{
"capabilityName": "<string>",
"scriptPath": "<string>"
}
],
"codeDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"automationReferences": [
{
"id": "<string>",
"name": "<string>",
"state": "active",
"configObjectVersionId": "<string>",
"input": "<unknown>"
}
],
"exampleInput": null
}
],
"latestSnapshot": {
"receiptId": "<string>",
"pluginId": "<string>",
"configObjectId": "<string>",
"configObjectVersionId": "<string>",
"automationRunId": "<string>",
"value": null,
"markdown": "<string>",
"codeDigest": "<string>",
"resultDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"rendererVersion": "codemode-markdown-v1",
"status": "succeeded",
"errorKind": "<string>",
"errorMessage": "<string>",
"source": "manual",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"contentDeletedAt": "2023-11-07T05:31:56Z"
},
"latestSuccessfulSnapshot": {
"receiptId": "<string>",
"pluginId": "<string>",
"configObjectId": "<string>",
"configObjectVersionId": "<string>",
"automationRunId": "<string>",
"value": null,
"markdown": "<string>",
"codeDigest": "<string>",
"resultDigest": "<string>",
"inputSchemaDigest": "<string>",
"outputSchemaDigest": "<string>",
"rendererVersion": "codemode-markdown-v1",
"status": "succeeded",
"errorKind": "<string>",
"errorMessage": "<string>",
"source": "manual",
"startedAt": "2023-11-07T05:31:56Z",
"finishedAt": "2023-11-07T05:31:56Z",
"contentDeletedAt": "2023-11-07T05:31:56Z"
},
"freshness": {
"state": "never_run"
}
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}Path Parameters
Body
application/json
Required string length:
1 - 255Required string length:
1 - 200000Maximum array length:
100Show child attributes
Show child attributes
Copy receiptId from the immediately preceding successful draft test. Submit the exact same name, description, code, exampleInput, inputSchema, outputSchema, and requiredCapabilities used by that test.
Required string length:
1 - 160Maximum string length:
4000Optional JSON Schema for the value returned by this Workflow.
Response
Workflow version created.
Required string length:
1 - 160Required string length:
1 - 160Required string length:
1 - 255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Was this page helpful?
⌘I