Workflow Definitions
List Workflow Runs Handler
GET
/
v1
/
workflow-definitions
/
{definition_id}
/
runs
List Workflow Runs Handler
curl --request GET \
--url http://localhost:8000/v1/workflow-definitions/{definition_id}/runsimport requests
url = "http://localhost:8000/v1/workflow-definitions/{definition_id}/runs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/v1/workflow-definitions/{definition_id}/runs', 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 => "8000",
CURLOPT_URL => "http://localhost:8000/v1/workflow-definitions/{definition_id}/runs",
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://localhost:8000/v1/workflow-definitions/{definition_id}/runs"
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://localhost:8000/v1/workflow-definitions/{definition_id}/runs")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/workflow-definitions/{definition_id}/runs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runner_type": "SELF_HOSTED",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"run_snapshot": {
"workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_name": "<string>",
"runner_type": "SELF_HOSTED",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"max_run_duration_seconds": 123,
"sources": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"instructions": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"outputs": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"template": {
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"limit": 2,
"offset": 1
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Path Parameters
Query Parameters
Number of items per page
Required range:
1 <= x <= 100Number of items to skip
Required range:
x >= 0Cookies
Response
Successful Response
⌘I
List Workflow Runs Handler
curl --request GET \
--url http://localhost:8000/v1/workflow-definitions/{definition_id}/runsimport requests
url = "http://localhost:8000/v1/workflow-definitions/{definition_id}/runs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/v1/workflow-definitions/{definition_id}/runs', 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 => "8000",
CURLOPT_URL => "http://localhost:8000/v1/workflow-definitions/{definition_id}/runs",
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://localhost:8000/v1/workflow-definitions/{definition_id}/runs"
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://localhost:8000/v1/workflow-definitions/{definition_id}/runs")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/v1/workflow-definitions/{definition_id}/runs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"runner_type": "SELF_HOSTED",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"run_snapshot": {
"workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_name": "<string>",
"runner_type": "SELF_HOSTED",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"max_run_duration_seconds": 123,
"sources": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"instructions": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"outputs": [
{
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
],
"template": {
"path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"materialized_path": "<string>"
}
},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"limit": 2,
"offset": 1
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}