Data API — Scientific Protocol Associations

14 min

scientific_protocol_add_associated_protocol

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

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

body — Associate a protocol to a scientific protocol

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_add_port

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

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

body — Create a port

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_get_associated_protocols

sync(scientific_protocol_id: UUID, client: AuthenticatedClient | Client, include_unlinked: bool | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | list[ScientificProtocolProtocolEligibleResponse] | None

Parameter	Type	Default
scientific_protocol_id	UUID	required
client	AuthenticatedClient \| Client	required
include_unlinked	bool \| Unset	UNSET

Returns: Any | ProblemDetails | list[ErrorResponse] | list[ScientificProtocolProtocolEligibleResponse] | 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_remove_associated_protocol

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

Parameter	Type	Default
scientific_protocol_id	UUID	required
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_remove_port

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

Parameter	Type	Default
scientific_protocol_id	UUID	required
port_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_update_associated_protocol

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

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

body — Update a protocol already associated with a scientific protocol

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_update_port

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

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

body — Create a port

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.