Data API — Protocols

22 min

generate_default_estimation_function

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | list[ErrorResponse] | str | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | list[ErrorResponse] | str | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_protocol_estimation_parameters

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | ProtocolEstimationParametersResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | ProtocolEstimationParametersResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_protocol_resource_reservations

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | ResourceReservationsResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | ResourceReservationsResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

protocol_create

sync(client: AuthenticatedClient | Client, body: CreateProtocolRequest | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateProtocolRequest \| Unset	UNSET

body — Properties used to create a new Protocol type Activity

Returns: ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

protocol_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

protocol_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | ProtocolResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | ProtocolResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

protocol_list

sync(client: AuthenticatedClient | Client, is_validated: bool | Unset = UNSET, is_cherry_pick: bool | Unset = UNSET, cellario_protocol_instance_filter_id: int | Unset = UNSET, cellario_protocol_instance_filter_name: str | Unset = UNSET, include: list[ProtocolInclude] | Unset = UNSET, system_assignment_ids: list[UUID] | Unset = UNSET, sort: list[ProtocolSort] | Unset = UNSET, type_: list[ActivityTypeEnum] | Unset = UNSET, organization_id: UUID | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, version: int | Unset = UNSET, reference_id: int | Unset = UNSET, is_requestable: bool | Unset = UNSET, is_published: bool | Unset = UNSET, include_all_versions: bool | Unset = UNSET, version_group_id: UUID | Unset = UNSET, date_created: datetime.datetime | Unset = UNSET, date_last_modified: datetime.datetime | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ProtocolListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
is_validated	bool \| Unset	UNSET
is_cherry_pick	bool \| Unset	UNSET
cellario_protocol_instance_filter_id	int \| Unset	UNSET
cellario_protocol_instance_filter_name	str \| Unset	UNSET
include	list[ProtocolInclude] \| Unset	UNSET
system_assignment_ids	list[UUID] \| Unset	UNSET
sort	list[ProtocolSort] \| Unset	UNSET
type_	list[ActivityTypeEnum] \| Unset	UNSET
organization_id	UUID \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
last_modified_by_user_id	UUID \| Unset	UNSET
name	str \| Unset	UNSET
description	str \| Unset	UNSET
thumbnail_ref	str \| Unset	UNSET
image_ref	str \| Unset	UNSET
version	int \| Unset	UNSET
reference_id	int \| Unset	UNSET
is_requestable	bool \| Unset	UNSET
is_published	bool \| Unset	UNSET
include_all_versions	bool \| Unset	UNSET
version_group_id	UUID \| Unset	UNSET
date_created	datetime.datetime \| Unset	UNSET
date_last_modified	datetime.datetime \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ProtocolListItemResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

protocol_update

sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateProtocolRequest | Unset = UNSET) -> ProblemDetails | ProtocolResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateProtocolRequest \| Unset	UNSET

body — Information used to update a protocol in CellarioOS. NOTE: Most protocol fields are synced from CellarioScheduler and cannot be updated here. Only CellarioOS-managed fields are included in this request.

Returns: ProblemDetails | ProtocolResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

test_protocol_estimation

sync(id: UUID, client: AuthenticatedClient | Client, body: EstimationTestRequest | Unset = UNSET) -> EstimationResultResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	EstimationTestRequest \| Unset	UNSET

body — Request to test a protocol estimation function with specific parameter values. Used to validate and preview estimation calculations before saving to the protocol.

Returns: EstimationResultResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

update_protocol_resource_reservations

sync(id: UUID, client: AuthenticatedClient | Client, body: list[ProtocolResourceReservationRequest] | Unset = UNSET) -> BulkReplaceReservationsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	list[ProtocolResourceReservationRequest] \| Unset	UNSET

Returns: BulkReplaceReservationsResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

workflow_component_protocol_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ProtocolListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ProtocolListItemResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.