Data API — Parameter Type Descriptors

14 min

clone_from_library_type

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

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

body — Request body for POST /parameters//clone- from-library-type. Carries the per-task overrides applied to the top-level clone of a library-type descriptor. Type and Widget are inherited from the source library type and cannot be overridden here.

Returns: ParameterTypeDescriptorResponse | 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.

create_parameter_type_descriptor

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

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

body — Request model for creating a new parameter type descriptor.

Returns: ParameterTypeDescriptorResponse | 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.

deactivate_parameter_type_descriptor

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.

get_parameter_type_descriptors

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, types: list[TaskParameterType] | Unset = UNSET, is_active: bool | Unset = UNSET, required: bool | Unset = UNSET, read_only: bool | Unset = UNSET, is_library_type: bool | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ParameterTypeDescriptorListResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
types	list[TaskParameterType] \| Unset	UNSET
is_active	bool \| Unset	UNSET
required	bool \| Unset	UNSET
read_only	bool \| Unset	UNSET
is_library_type	bool \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[ParameterTypeDescriptorListResponse] | 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_parameter_type_descriptor_by_id

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

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

Returns: ParameterTypeDescriptorResponse | 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.

reactivate_parameter_type_descriptor

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

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

Returns: ParameterTypeDescriptorResponse | 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_parameter_type_descriptor

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

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

body — Request model for updating a parameter type descriptor. IsLibraryType is inherited from Cellario.Cloud.Data.Api.Models.Parameters.CreateParameterTypeDescriptorRequest as a nullable bool and follows PATCH-style "null leaves unchanged" semantics here.

Returns: ParameterTypeDescriptorResponse | 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.