Execution API
Get workflow execution status
Legacy path: /api/workflow//status/ (deprecated)
GET
/
api
/
executions
/
{executionId}
Get workflow execution status
curl --request GET \
--url http://localhost:8080/api/executions/{executionId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/api/executions/{executionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/api/executions/{executionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/executions/{executionId}",
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 := "http://localhost:8080/api/executions/{executionId}"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/executions/{executionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/executions/{executionId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"timestamp": "2023-11-07T05:31:56Z",
"status": 200,
"message": "Operation successful",
"data": {
"executionId": "<string>",
"sessionId": "<string>",
"workflowId": "<string>",
"status": "<string>",
"tasks": [
{
"nodeId": "<string>",
"module": "<string>",
"status": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"controlState": "<string>",
"definitionVersion": "<string>"
},
"error": "Bad Request",
"path": "/api/files",
"errors": [
{
"field": "sessionId",
"message": "Session not found: 'unknown-session'"
}
]
}Authorizations
bearerAuthapiKeyAuth
API key sent as Authorization: Bearer <key>. Needed only when the server has a key configured.
Path Parameters
Execution ID
Response
200 - */*
OK
Unified API response wrapper for both success and error responses. Success responses include data field; error responses include error, path, and errors fields.
The time the response was generated
The HTTP status code
Example:
200
A human-readable message
Example:
"Operation successful"
The response data
Show child attributes
Show child attributes
The HTTP status error name
Example:
"Bad Request"
The request path
Example:
"/api/files"
The list of field validation errors
Show child attributes
Show child attributes
⌘I
Get workflow execution status
curl --request GET \
--url http://localhost:8080/api/executions/{executionId} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/api/executions/{executionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/api/executions/{executionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/executions/{executionId}",
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 := "http://localhost:8080/api/executions/{executionId}"
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))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/executions/{executionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/executions/{executionId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"timestamp": "2023-11-07T05:31:56Z",
"status": 200,
"message": "Operation successful",
"data": {
"executionId": "<string>",
"sessionId": "<string>",
"workflowId": "<string>",
"status": "<string>",
"tasks": [
{
"nodeId": "<string>",
"module": "<string>",
"status": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"controlState": "<string>",
"definitionVersion": "<string>"
},
"error": "Bad Request",
"path": "/api/files",
"errors": [
{
"field": "sessionId",
"message": "Session not found: 'unknown-session'"
}
]
}