collections_items_put_item

Update a single item’s metadata

Functions

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

Update a single item’s metadata

Update the item definition, such as its name, folder ID, metadata, storage, and parsing settings.

This method can be used to move items to new folders, rename items, add or remove parsing settings, or update link targets. It cannot be used to change an item’s type, alter its status, or move it to a new datastore. Performing those actions will require deleting and recreating the item.

Changing the item’s contents can be done using the …/{item_id}/data API endpoints.

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

Return type:

Item

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

Update a single item’s metadata

Update the item definition, such as its name, folder ID, metadata, storage, and parsing settings.

This method can be used to move items to new folders, rename items, add or remove parsing settings, or update link targets. It cannot be used to change an item’s type, alter its status, or move it to a new datastore. Performing those actions will require deleting and recreating the item.

Changing the item’s contents can be done using the …/{item_id}/data API endpoints.

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

Return type:

Response[Item | ServerError]

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

Update a single item’s metadata

Update the item definition, such as its name, folder ID, metadata, storage, and parsing settings.

This method can be used to move items to new folders, rename items, add or remove parsing settings, or update link targets. It cannot be used to change an item’s type, alter its status, or move it to a new datastore. Performing those actions will require deleting and recreating the item.

Changing the item’s contents can be done using the …/{item_id}/data API endpoints.

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

Return type:

Item

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

Update a single item’s metadata

Update the item definition, such as its name, folder ID, metadata, storage, and parsing settings.

This method can be used to move items to new folders, rename items, add or remove parsing settings, or update link targets. It cannot be used to change an item’s type, alter its status, or move it to a new datastore. Performing those actions will require deleting and recreating the item.

Changing the item’s contents can be done using the …/{item_id}/data API endpoints.

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

Return type:

Response[Item | ServerError]