collections_items_get_item¶
Retrieve a single item’s metadata
Functions
- async pydelfini.delfini_core.api.items.collections_items_get_item.asyncio(collection_id, version_id, item_id, *, client)[source]¶
Retrieve a single item’s metadata
Retrieve the complete item definition, including its name, type, folder ID, metadata, storage, and parsing settings, along with a short summary of the item’s storage, parsing, and validation status.
- Parameters:
collection_id (str)
version_id (str)
item_id (str)
client (AuthenticatedClient)
- 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[Item]
- Return type:
- async pydelfini.delfini_core.api.items.collections_items_get_item.asyncio_detailed(collection_id, version_id, item_id, *, client)[source]¶
Retrieve a single item’s metadata
Retrieve the complete item definition, including its name, type, folder ID, metadata, storage, and parsing settings, along with a short summary of the item’s storage, parsing, and validation status.
- Parameters:
collection_id (str)
version_id (str)
item_id (str)
client (AuthenticatedClient)
- 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[Item, ServerError]]
- Return type:
- pydelfini.delfini_core.api.items.collections_items_get_item.sync(collection_id, version_id, item_id, *, client)[source]¶
Retrieve a single item’s metadata
Retrieve the complete item definition, including its name, type, folder ID, metadata, storage, and parsing settings, along with a short summary of the item’s storage, parsing, and validation status.
- Parameters:
collection_id (str)
version_id (str)
item_id (str)
client (AuthenticatedClient)
- 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[Item]
- Return type:
- pydelfini.delfini_core.api.items.collections_items_get_item.sync_detailed(collection_id, version_id, item_id, *, client)[source]¶
Retrieve a single item’s metadata
Retrieve the complete item definition, including its name, type, folder ID, metadata, storage, and parsing settings, along with a short summary of the item’s storage, parsing, and validation status.
- Parameters:
collection_id (str)
version_id (str)
item_id (str)
client (AuthenticatedClient)
- 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[Item, ServerError]]
- Return type: