Set Task Run State

{
  "state": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "SCHEDULED",
    "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"
    }
  },
  "status": "ACCEPT",
  "details": {
    "type": "accept_details"
  }
}

POST

api

task_runs

{id}

set_state

{
  "state": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "SCHEDULED",
    "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"
    }
  },
  "status": "ACCEPT",
  "details": {
    "type": "accept_details"
  }
}

Headers

x-prefect-api-version

string

Path Parameters

string<uuid>

required

The task run id

Body

application/json

state

StateCreate · object

required

The intended state.

Show child attributes

state.type

enum<string>

required

The type of the state to create

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

state.name

string | null

The name of the state to create

state.message

string | null

The message of the state to create

state.data

any | null

The data of the state to create

state.state_details

StateDetails · object

The details of the state to create

Show child attributes

state.state_details.flow_run_id

string<uuid> | null

state.state_details.task_run_id

string<uuid> | null

state.state_details.child_flow_run_id

string<uuid> | null

state.state_details.scheduled_time

string<date-time> | null

state.state_details.cache_key

string | null

state.state_details.cache_expiration

string<date-time> | null

state.state_details.deferred

boolean | null

default:false

state.state_details.untrackable_result

boolean

default:false

state.state_details.pause_timeout

string<date-time> | null

state.state_details.pause_reschedule

boolean

default:false

state.state_details.pause_key

string | null

state.state_details.run_input_keyset

Run Input Keyset · object

Show child attributes

state.state_details.run_input_keyset.{key}

string

state.state_details.refresh_cache

boolean | null

state.state_details.retriable

boolean | null

state.state_details.transition_id

string<uuid> | null

state.state_details.task_parameters_id

string<uuid> | null

state.state_details.traceparent

string | null

state.state_details.deployment_concurrency_lease_id

string<uuid> | null

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.

Response

Successful Response

A container for the output of state orchestration.

state

State · object

required

Represents the state of a run.

Show child attributes

state.id

string<uuid>

required

state.type

enum<string>

required

Enumeration of state types.

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

state.name

string | null

state.timestamp

string<date-time>

state.message

string | null

Example:

"Run started"

state.data

any | null

Data associated with the state, e.g. a result. Content must be storable as JSON.

state.state_details

StateDetails · object

Show child attributes

state.state_details.flow_run_id

string<uuid> | null

state.state_details.task_run_id

string<uuid> | null

state.state_details.child_flow_run_id

string<uuid> | null

state.state_details.scheduled_time

string<date-time> | null

state.state_details.cache_key

string | null

state.state_details.cache_expiration

string<date-time> | null

state.state_details.deferred

boolean | null

default:false

state.state_details.untrackable_result

boolean

default:false

state.state_details.pause_timeout

string<date-time> | null

state.state_details.pause_reschedule

boolean

default:false

state.state_details.pause_key

string | null

state.state_details.run_input_keyset

Run Input Keyset · object

Show child attributes

state.state_details.run_input_keyset.{key}

string

state.state_details.refresh_cache

boolean | null

state.state_details.retriable

boolean | null

state.state_details.transition_id

string<uuid> | null

state.state_details.task_parameters_id

string<uuid> | null

state.state_details.traceparent

string | null

state.state_details.deployment_concurrency_lease_id

string<uuid> | null

status

enum<string>

required

Enumerates return statuses for setting run states.

Available options:

ACCEPT,

REJECT,

ABORT,

WAIT

details

StateAcceptDetails · object

required

Details associated with an ACCEPT state transition.

StateAcceptDetails
StateWaitDetails
StateRejectDetails
StateAbortDetails

Show child attributes

details.type

string

default:accept_details

The type of state transition detail. Used to ensure pydantic does not coerce into a different type.

Allowed value: "accept_details"

Paginate Task Runs Read Flow Run State

⌘I

API Reference

Headers

Path Parameters

Body

Response