Data API — Schemas

10 min

create_custom_schema

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

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

body — A custom schema for various objects which defines a set of custom strongly typed properties

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

delete_custom_schema

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

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

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.

get_custom_schema

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

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

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

list_custom_schemas

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, apply_to_all_types: bool | Unset = UNSET, schema_type: SchemaTypeEnum | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CustomSchemaResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
apply_to_all_types	bool \| Unset	UNSET
schema_type	SchemaTypeEnum \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CustomSchemaResponse] | 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_custom_schema

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

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

body — A custom schema for various objects which defines a set of custom strongly typed properties

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