Data API — Scientific Protocols

10 min

scientific_protocol_by_id

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

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

Returns: ProblemDetails | ScientificProtocolResponse | 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.

scientific_protocol_create

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

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

body — Detailed information about a scientific protocol

Returns: ProblemDetails | ScientificProtocolResponse | 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.

scientific_protocol_delete

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

Parameter	Type	Default
scientific_protocol_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.

scientific_protocol_list

sync(client: AuthenticatedClient | Client, default_protocol_id: UUID | Unset = UNSET, protocol_ids: list[UUID] | Unset = UNSET, include: list[ScientificProtocolInclude] | 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, is_science_protocol_requestable: bool | Unset = UNSET, requires_transfer_list: bool | Unset = UNSET, properties: list[str] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ScientificProtocolListItemResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
default_protocol_id	UUID \| Unset	UNSET
protocol_ids	list[UUID] \| Unset	UNSET
include	list[ScientificProtocolInclude] \| 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
is_science_protocol_requestable	bool \| Unset	UNSET
requires_transfer_list	bool \| Unset	UNSET
properties	list[str] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ScientificProtocolListItemResponse] | 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.

scientific_protocol_update

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

Parameter	Type	Default
scientific_protocol_id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateScientificProtocolRequest \| Unset	UNSET

body — Detailed information about a scientific protocol

Returns: ProblemDetails | ScientificProtocolResponse | 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.