prefect.orion.api.flow_run_states
Routes for interacting with flow run state objects.
read_flow_run_state
async
Get a flow run state by id.
Source code in prefect/orion/api/flow_run_states.py
@router.get("/{id}")
async def read_flow_run_state(
flow_run_state_id: UUID = Path(
..., description="The flow run state id", alias="id"
),
session: sa.orm.Session = Depends(dependencies.get_session),
) -> schemas.states.State:
"""
Get a flow run state by id.
"""
flow_run_state = await models.flow_run_states.read_flow_run_state(
session=session, flow_run_state_id=flow_run_state_id
)
if not flow_run_state:
raise HTTPException(
status.HTTP_404_NOT_FOUND, detail="Flow run state not found"
)
return flow_run_state
read_flow_run_states
async
Get states associated with a flow run.
Source code in prefect/orion/api/flow_run_states.py
@router.get("/")
async def read_flow_run_states(
flow_run_id: UUID,
session: sa.orm.Session = Depends(dependencies.get_session),
) -> List[schemas.states.State]:
"""
Get states associated with a flow run.
"""
return await models.flow_run_states.read_flow_run_states(
session=session, flow_run_id=flow_run_id
)