Data API — Instructions

10 min

instruction_by_id

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

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

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

instruction_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.

instruction_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, operation: str | Unset = UNSET, resource_id: UUID | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, sort: list[InstructionSort] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[InstructionResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
operation	str \| Unset	UNSET
resource_id	UUID \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
sort	list[InstructionSort] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

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

instruction_update

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

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

body — Fields to be changed for an existing instruction

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

post_v1_instructions

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

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

body — Information to create an instruction

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