collections_dictionaries_get_order

Get the current preferred order of elements and bundles

Functions

async pydelfini.delfini_core.api.data_dictionaries.collections_dictionaries_get_order.asyncio(collection_id, version_id, item_id, *, client)[source]

Get the current preferred order of elements and bundles

TODO

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[PreferredOrder]

Return type:

PreferredOrder

async pydelfini.delfini_core.api.data_dictionaries.collections_dictionaries_get_order.asyncio_detailed(collection_id, version_id, item_id, *, client)[source]

Get the current preferred order of elements and bundles

TODO

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[PreferredOrder, ServerError]]

Return type:

Response[PreferredOrder | ServerError]

pydelfini.delfini_core.api.data_dictionaries.collections_dictionaries_get_order.sync(collection_id, version_id, item_id, *, client)[source]

Get the current preferred order of elements and bundles

TODO

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[PreferredOrder]

Return type:

PreferredOrder

pydelfini.delfini_core.api.data_dictionaries.collections_dictionaries_get_order.sync_detailed(collection_id, version_id, item_id, *, client)[source]

Get the current preferred order of elements and bundles

TODO

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[PreferredOrder, ServerError]]

Return type:

Response[PreferredOrder | ServerError]