Inspect a Workflow
curl --request GET \
--url http://api.den.local/v1/workflows/{configObjectId}import requests
url = "http://api.den.local/v1/workflows/{configObjectId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://api.den.local/v1/workflows/{configObjectId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://api.den.local/v1/workflows/{configObjectId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://api.den.local/v1/workflows/{configObjectId}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/workflows/{configObjectId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"workflow": {
"type": "workflow",
"id": "<string>",
"plugin": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"description": "<string>",
"role": "viewer",
"edges": [
"<unknown>"
],
"state": "ready",
"resultState": "never_run",
"latestSuccessfulAt": "2023-11-07T05:31:56Z",
"viewState": "default",
"activeViewTitle": "<string>",
"automationCount": 4503599627370495,
"source": {
"kind": "created",
"templateName": "<string>",
"templateVersion": "<string>"
}
},
"script": {
"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"
}
},
"views": [
{
"id": "<string>",
"configObjectId": "<string>",
"title": "<string>",
"description": "<string>",
"status": "active",
"activeRevisionId": "<string>",
"revisions": [
{
"id": "<string>",
"artifactViewId": "<string>",
"resourceUri": "<string>",
"buildStatus": "ready",
"sourceDigest": "<string>",
"resourceDigest": "<string>",
"outputSchemaDigest": "<string>",
"csp": {
"connectDomains": [
"<string>"
],
"resourceDomains": [
"<string>"
],
"frameDomains": [
"<string>"
],
"baseUriDomains": [
"<string>"
]
},
"diagnostics": [
{
"level": "error",
"message": "<string>",
"line": 4503599627370495,
"column": 4503599627370495
}
],
"compilerName": "<string>",
"compilerVersion": "<string>",
"reactVersion": "<string>",
"compiledHtmlBytes": 4503599627370495,
"retiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>",
"message": "<string>"
}Workflows
Inspect a Workflow
GET
/
v1
/
workflows
/
{configObjectId}
Inspect a Workflow
curl --request GET \
--url http://api.den.local/v1/workflows/{configObjectId}import requests
url = "http://api.den.local/v1/workflows/{configObjectId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://api.den.local/v1/workflows/{configObjectId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://api.den.local/v1/workflows/{configObjectId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://api.den.local/v1/workflows/{configObjectId}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.den.local/v1/workflows/{configObjectId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"workflow": {
"type": "workflow",
"id": "<string>",
"plugin": {
"id": "<string>",
"name": "<string>"
},
"name": "<string>",
"description": "<string>",
"role": "viewer",
"edges": [
"<unknown>"
],
"state": "ready",
"resultState": "never_run",
"latestSuccessfulAt": "2023-11-07T05:31:56Z",
"viewState": "default",
"activeViewTitle": "<string>",
"automationCount": 4503599627370495,
"source": {
"kind": "created",
"templateName": "<string>",
"templateVersion": "<string>"
}
},
"script": {
"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"
}
},
"views": [
{
"id": "<string>",
"configObjectId": "<string>",
"title": "<string>",
"description": "<string>",
"status": "active",
"activeRevisionId": "<string>",
"revisions": [
{
"id": "<string>",
"artifactViewId": "<string>",
"resourceUri": "<string>",
"buildStatus": "ready",
"sourceDigest": "<string>",
"resourceDigest": "<string>",
"outputSchemaDigest": "<string>",
"csp": {
"connectDomains": [
"<string>"
],
"resourceDomains": [
"<string>"
],
"frameDomains": [
"<string>"
],
"baseUriDomains": [
"<string>"
]
},
"diagnostics": [
{
"level": "error",
"message": "<string>",
"line": 4503599627370495,
"column": 4503599627370495
}
],
"compilerName": "<string>",
"compilerVersion": "<string>",
"reactVersion": "<string>",
"compiledHtmlBytes": 4503599627370495,
"retiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>",
"message": "<string>"
}Was this page helpful?
⌘I