Data API — Failures
failures_list
sync(client: AuthenticatedClient | Client, type_: FailureType | Unset = UNSET, system_id: UUID | Unset = UNSET, location_id: UUID | Unset = UNSET, resolution: FailureResolution | Unset = UNSET, state: FailureState | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[FailureResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
type_ | FailureType | Unset | UNSET |
system_id | UUID | Unset | UNSET |
location_id | UUID | Unset | UNSET |
resolution | FailureResolution | Unset | UNSET |
state | FailureState | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[FailureResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |
failure_describe
sync(id: UUID, client: AuthenticatedClient | Client) -> FailureResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: FailureResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
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. |