Skip to main content
POST
/
flow_runs
/
bulk_set_state
Bulk Set Flow Run State
curl --request POST \
  --url https://api.example.com/flow_runs/bulk_set_state \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": {
    "name": "<string>",
    "message": "<string>",
    "data": "<unknown>",
    "state_details": {
      "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "child_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduled_time": "2023-11-07T05:31:56Z",
      "cache_key": "<string>",
      "cache_expiration": "2023-11-07T05:31:56Z",
      "deferred": false,
      "untrackable_result": false,
      "pause_timeout": "2023-11-07T05:31:56Z",
      "pause_reschedule": false,
      "pause_key": "<string>",
      "run_input_keyset": {},
      "refresh_cache": true,
      "retriable": true,
      "transition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "traceparent": "<string>",
      "deployment_concurrency_lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "flow_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-flow-run-1",
        "my-flow-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "deployment_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "operator": "and_",
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [],
        "not_any_": []
      },
      "name": {
        "any_": [
          "<string>"
        ],
        "not_any_": [
          "<string>"
        ]
      }
    },
    "flow_version": {
      "any_": [
        "<string>"
      ]
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "end_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "next_scheduled_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "parent_flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "parent_task_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "idempotency_key": {
      "any_": [
        "<string>"
      ],
      "not_any_": [
        "<string>"
      ]
    },
    "created_by": {
      "operator": "and_",
      "id_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "type_": [
        "DEPLOYMENT",
        "AUTOMATION"
      ],
      "is_null_": true
    }
  },
  "force": false,
  "limit": 50
}
'
import requests

url = "https://api.example.com/flow_runs/bulk_set_state"

payload = {
"state": {
"name": "<string>",
"message": "<string>",
"data": "<unknown>",
"state_details": {
"flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"child_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scheduled_time": "2023-11-07T05:31:56Z",
"cache_key": "<string>",
"cache_expiration": "2023-11-07T05:31:56Z",
"deferred": False,
"untrackable_result": False,
"pause_timeout": "2023-11-07T05:31:56Z",
"pause_reschedule": False,
"pause_key": "<string>",
"run_input_keyset": {},
"refresh_cache": True,
"retriable": True,
"transition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"task_parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"traceparent": "<string>",
"deployment_concurrency_lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"not_any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"name": {
"any_": ["my-flow-run-1", "my-flow-run-2"],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"any_": ["tag-1", "tag-2"],
"is_null_": True
},
"deployment_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_null_": True
},
"work_queue_name": {
"operator": "and_",
"any_": ["work_queue_1", "work_queue_2"],
"is_null_": True
},
"state": {
"operator": "and_",
"type": {
"any_": [],
"not_any_": []
},
"name": {
"any_": ["<string>"],
"not_any_": ["<string>"]
}
},
"flow_version": { "any_": ["<string>"] },
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"parent_task_run_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_null_": True
},
"idempotency_key": {
"any_": ["<string>"],
"not_any_": ["<string>"]
},
"created_by": {
"operator": "and_",
"id_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"type_": ["DEPLOYMENT", "AUTOMATION"],
"is_null_": True
}
},
"force": False,
"limit": 50
}
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({
state: {
name: '<string>',
message: '<string>',
data: '<unknown>',
state_details: {
flow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
task_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
child_flow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scheduled_time: '2023-11-07T05:31:56Z',
cache_key: '<string>',
cache_expiration: '2023-11-07T05:31:56Z',
deferred: false,
untrackable_result: false,
pause_timeout: '2023-11-07T05:31:56Z',
pause_reschedule: false,
pause_key: '<string>',
run_input_keyset: {},
refresh_cache: true,
retriable: true,
transition_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
task_parameters_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
traceparent: '<string>',
deployment_concurrency_lease_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
},
flow_runs: {
operator: 'and_',
id: {
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
not_any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
name: {any_: ['my-flow-run-1', 'my-flow-run-2'], like_: 'marvin'},
tags: {
operator: 'and_',
all_: ['tag-1', 'tag-2'],
any_: ['tag-1', 'tag-2'],
is_null_: true
},
deployment_id: {
operator: 'and_',
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_null_: true
},
work_queue_name: {operator: 'and_', any_: ['work_queue_1', 'work_queue_2'], is_null_: true},
state: {
operator: 'and_',
type: {any_: [], not_any_: []},
name: {any_: ['<string>'], not_any_: ['<string>']}
},
flow_version: {any_: ['<string>']},
start_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
end_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
expected_start_time: {before_: '2023-11-07T05:31:56Z', after_: '2023-11-07T05:31:56Z'},
next_scheduled_start_time: {before_: '2023-11-07T05:31:56Z', after_: '2023-11-07T05:31:56Z'},
parent_flow_run_id: {operator: 'and_', any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
parent_task_run_id: {
operator: 'and_',
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_null_: true
},
idempotency_key: {any_: ['<string>'], not_any_: ['<string>']},
created_by: {
operator: 'and_',
id_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
type_: ['DEPLOYMENT', 'AUTOMATION'],
is_null_: true
}
},
force: false,
limit: 50
})
};

fetch('https://api.example.com/flow_runs/bulk_set_state', 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.example.com/flow_runs/bulk_set_state",
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([
'state' => [
'name' => '<string>',
'message' => '<string>',
'data' => '<unknown>',
'state_details' => [
'flow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'task_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'child_flow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scheduled_time' => '2023-11-07T05:31:56Z',
'cache_key' => '<string>',
'cache_expiration' => '2023-11-07T05:31:56Z',
'deferred' => false,
'untrackable_result' => false,
'pause_timeout' => '2023-11-07T05:31:56Z',
'pause_reschedule' => false,
'pause_key' => '<string>',
'run_input_keyset' => [

],
'refresh_cache' => true,
'retriable' => true,
'transition_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'task_parameters_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'traceparent' => '<string>',
'deployment_concurrency_lease_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'flow_runs' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'not_any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'my-flow-run-1',
'my-flow-run-2'
],
'like_' => 'marvin'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'any_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
],
'deployment_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'is_null_' => true
],
'work_queue_name' => [
'operator' => 'and_',
'any_' => [
'work_queue_1',
'work_queue_2'
],
'is_null_' => true
],
'state' => [
'operator' => 'and_',
'type' => [
'any_' => [

],
'not_any_' => [

]
],
'name' => [
'any_' => [
'<string>'
],
'not_any_' => [
'<string>'
]
]
],
'flow_version' => [
'any_' => [
'<string>'
]
],
'start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'end_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'expected_start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z'
],
'next_scheduled_start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z'
],
'parent_flow_run_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'parent_task_run_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'is_null_' => true
],
'idempotency_key' => [
'any_' => [
'<string>'
],
'not_any_' => [
'<string>'
]
],
'created_by' => [
'operator' => 'and_',
'id_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'type_' => [
'DEPLOYMENT',
'AUTOMATION'
],
'is_null_' => true
]
],
'force' => false,
'limit' => 50
]),
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 := "https://api.example.com/flow_runs/bulk_set_state"

payload := strings.NewReader("{\n \"state\": {\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"data\": \"<unknown>\",\n \"state_details\": {\n \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"child_flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n \"cache_key\": \"<string>\",\n \"cache_expiration\": \"2023-11-07T05:31:56Z\",\n \"deferred\": false,\n \"untrackable_result\": false,\n \"pause_timeout\": \"2023-11-07T05:31:56Z\",\n \"pause_reschedule\": false,\n \"pause_key\": \"<string>\",\n \"run_input_keyset\": {},\n \"refresh_cache\": true,\n \"retriable\": true,\n \"transition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_parameters_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"traceparent\": \"<string>\",\n \"deployment_concurrency_lease_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"force\": false,\n \"limit\": 50\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("https://api.example.com/flow_runs/bulk_set_state")
.header("Content-Type", "application/json")
.body("{\n \"state\": {\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"data\": \"<unknown>\",\n \"state_details\": {\n \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"child_flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n \"cache_key\": \"<string>\",\n \"cache_expiration\": \"2023-11-07T05:31:56Z\",\n \"deferred\": false,\n \"untrackable_result\": false,\n \"pause_timeout\": \"2023-11-07T05:31:56Z\",\n \"pause_reschedule\": false,\n \"pause_key\": \"<string>\",\n \"run_input_keyset\": {},\n \"refresh_cache\": true,\n \"retriable\": true,\n \"transition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_parameters_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"traceparent\": \"<string>\",\n \"deployment_concurrency_lease_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"force\": false,\n \"limit\": 50\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/flow_runs/bulk_set_state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"state\": {\n \"name\": \"<string>\",\n \"message\": \"<string>\",\n \"data\": \"<unknown>\",\n \"state_details\": {\n \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"child_flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scheduled_time\": \"2023-11-07T05:31:56Z\",\n \"cache_key\": \"<string>\",\n \"cache_expiration\": \"2023-11-07T05:31:56Z\",\n \"deferred\": false,\n \"untrackable_result\": false,\n \"pause_timeout\": \"2023-11-07T05:31:56Z\",\n \"pause_reschedule\": false,\n \"pause_key\": \"<string>\",\n \"run_input_keyset\": {},\n \"refresh_cache\": true,\n \"retriable\": true,\n \"transition_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"task_parameters_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"traceparent\": \"<string>\",\n \"deployment_concurrency_lease_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"force\": false,\n \"limit\": 50\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "details": {
        "type": "accept_details"
      },
      "state": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "message": "Run started",
        "data": "<unknown>",
        "state_details": {
          "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "child_flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled_time": "2023-11-07T05:31:56Z",
          "cache_key": "<string>",
          "cache_expiration": "2023-11-07T05:31:56Z",
          "deferred": false,
          "untrackable_result": false,
          "pause_timeout": "2023-11-07T05:31:56Z",
          "pause_reschedule": false,
          "pause_key": "<string>",
          "run_input_keyset": {},
          "refresh_cache": true,
          "retriable": true,
          "transition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "task_parameters_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "traceparent": "<string>",
          "deployment_concurrency_lease_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

x-prefect-api-version
string

Body

application/json
state
StateCreate · object
required

The state to set

flow_runs
FlowRunFilter · object | null

Filter criteria for flow runs to update

force
boolean
default:false

If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.

limit
integer
default:50

Maximum number of flow runs to update. Defaults to 50.

Required range: 1 <= x <= 50

Response

Successful Response

Response from bulk set state operation.

results
FlowRunOrchestrationResult · object[]