collections_dictionaries_view_order

Retrieve elements and bundles according to the proposed order

Functions

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

Retrieve elements and bundles according to the proposed order

This only previews the order and does not set it permanently.

Even though the response includes pagination information, the result will be unpaginated to facilitate bulk processing.

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[OrderedDictionary]

Return type:

OrderedDictionary

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

Retrieve elements and bundles according to the proposed order

This only previews the order and does not set it permanently.

Even though the response includes pagination information, the result will be unpaginated to facilitate bulk processing.

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[OrderedDictionary, ServerError]]

Return type:

Response[OrderedDictionary | ServerError]

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

Retrieve elements and bundles according to the proposed order

This only previews the order and does not set it permanently.

Even though the response includes pagination information, the result will be unpaginated to facilitate bulk processing.

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[OrderedDictionary]

Return type:

OrderedDictionary

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

Retrieve elements and bundles according to the proposed order

This only previews the order and does not set it permanently.

Even though the response includes pagination information, the result will be unpaginated to facilitate bulk processing.

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[OrderedDictionary, ServerError]]

Return type:

Response[OrderedDictionary | ServerError]