Data API — Resources
get_resource_scheduler_state
sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | ResourceStateResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | ResourceStateResponse | 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. |
post_v1_resources
sync(client: AuthenticatedClient | Client, body: CreateResourceRequest | Unset = UNSET) -> ProblemDetails | ResourceResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | CreateResourceRequest | Unset | UNSET |
- body — Information used to create a new resource
Returns: ProblemDetails | ResourceResponse | 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. |
reinitialize_scheduler_resource
sync(id: UUID, client: AuthenticatedClient | Client, requesting_workflow_order_id: UUID | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
requesting_workflow_order_id | UUID | Unset | UNSET |
Returns: 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. |
resources_list
sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, make: str | Unset = UNSET, model: str | Unset = UNSET, variant: str | Unset = UNSET, state: ResourceState | Unset = UNSET, location_id: UUID | Unset = UNSET, cart_id: UUID | Unset = UNSET, cellario_system_id: UUID | Unset = UNSET, cellario_system_name: str | Unset = UNSET, driver_package_name: str | Unset = UNSET, driver_version: str | Unset = UNSET, serial_number: str | Unset = UNSET, data_collection: ResourceDataSetting | Unset = UNSET, sort: list[ResourceSort] | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ResourceResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
name | str | Unset | UNSET |
make | str | Unset | UNSET |
model | str | Unset | UNSET |
variant | str | Unset | UNSET |
state | ResourceState | Unset | UNSET |
location_id | UUID | Unset | UNSET |
cart_id | UUID | Unset | UNSET |
cellario_system_id | UUID | Unset | UNSET |
cellario_system_name | str | Unset | UNSET |
driver_package_name | str | Unset | UNSET |
driver_version | str | Unset | UNSET |
serial_number | str | Unset | UNSET |
data_collection | ResourceDataSetting | Unset | UNSET |
sort | list[ResourceSort] | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[ResourceResponse] | 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. |
resource_by_id
sync(id: UUID, client: AuthenticatedClient | Client, include: list[ResourceInclude] | Unset = UNSET) -> ProblemDetails | ResourceResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
include | list[ResourceInclude] | Unset | UNSET |
Returns: ProblemDetails | ResourceResponse | 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. |
resource_delete
sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | 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. |
resource_update
sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateResourceRequest | Unset = UNSET) -> ProblemDetails | ResourceResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
body | UpdateResourceRequest | Unset | UNSET |
- body — Form to provide updated information to a resource
Returns: ProblemDetails | ResourceResponse | 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. |