collections_archives_create_archive

Request a downloadable ZIP archive of a collection

Functions

async pydelfini.delfini_core.api.collections.collections_archives_create_archive.asyncio(collection_id, version_id, *, client, body)

Request a downloadable ZIP archive of a collection

Starts a background job that bundles the collection’s items into a single ZIP file, along with a manifest.json describing every entry in the collection and its download status. A request that matches an archive already built, or already being built, joins that one instead of doing the work twice.

Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing archive was reused.

Parameters:

• collection_id (str)

• version_id (str)

• body (CollectionArchiveRequest) – Selects what the archive contains. An empty request means the whole collection version; itemIds limits it to those items, and inFolder to a folder’s contents, recursively.

• 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[CollectionArchive]

Return type:

CollectionArchive

async pydelfini.delfini_core.api.collections.collections_archives_create_archive.asyncio_detailed(collection_id, version_id, *, client, body)

Request a downloadable ZIP archive of a collection

Starts a background job that bundles the collection’s items into a single ZIP file, along with a manifest.json describing every entry in the collection and its download status. A request that matches an archive already built, or already being built, joins that one instead of doing the work twice.

Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing archive was reused.

Parameters:

• collection_id (str)

• version_id (str)

• body (CollectionArchiveRequest) – Selects what the archive contains. An empty request means the whole collection version; itemIds limits it to those items, and inFolder to a folder’s contents, recursively.

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

Return type:

Response[CollectionArchive | ServerError]

pydelfini.delfini_core.api.collections.collections_archives_create_archive.sync(collection_id, version_id, *, client, body)

Request a downloadable ZIP archive of a collection

Starts a background job that bundles the collection’s items into a single ZIP file, along with a manifest.json describing every entry in the collection and its download status. A request that matches an archive already built, or already being built, joins that one instead of doing the work twice.

Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing archive was reused.

Parameters:

• collection_id (str)

• version_id (str)

• body (CollectionArchiveRequest) – Selects what the archive contains. An empty request means the whole collection version; itemIds limits it to those items, and inFolder to a folder’s contents, recursively.

• 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[CollectionArchive]

Return type:

CollectionArchive

pydelfini.delfini_core.api.collections.collections_archives_create_archive.sync_detailed(collection_id, version_id, *, client, body)

Request a downloadable ZIP archive of a collection

Starts a background job that bundles the collection’s items into a single ZIP file, along with a manifest.json describing every entry in the collection and its download status. A request that matches an archive already built, or already being built, joins that one instead of doing the work twice.

Responds 202 when a new build was queued, with a Location header addressing the status resource to poll. Responds 200 when an existing archive was reused.

Parameters:

• collection_id (str)

• version_id (str)

• body (CollectionArchiveRequest) – Selects what the archive contains. An empty request means the whole collection version; itemIds limits it to those items, and inFolder to a folder’s contents, recursively.

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

Return type:

Response[CollectionArchive | ServerError]