Update Archive Items

Update the content of archive items

To update the contents of a archive items you can use the convenience function: Client.update_archive_item, together with one or more SocketValueSpecs.

Example

First, retrieve the archive items from your archive:

archive = client.archives.detail(slug="my-archive-slug")
archive_items = list(
    client.archive_items.iterate_all(
        params={"archive": archive.pk}
    )
)

To then add, for example, a PDF report and a lung volume value to the first archive item, provide the socket slugs together with the respective value or file path as follows:

from gcapi import SocketValueSpec

client.update_archive_item(
    archive_item_pk=archive_items[0].pk,
    values=[
        SocketValueSpec(socket_slug="report", file="path/on/your/machine/to/the/report.pdf"),
        SocketValueSpec(socket_slug="lung-volume", value=1.9),
    ]
)

Warning

If you provide a value or file for an already existing socket value of the archive item, the old value will be overwritten by the new one.