qcrboxapiclient.api.datasets.download_dataset_by_id¶
- async qcrboxapiclient.api.datasets.download_dataset_by_id.asyncio(id, *, client)¶
Download a dataset
Download the data files of a datast as a Zip file.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Union[QCrBoxErrorResponse,str,None]- Returns:
Union[QCrBoxErrorResponse, str]
- async qcrboxapiclient.api.datasets.download_dataset_by_id.asyncio_detailed(id, *, client)¶
Download a dataset
Download the data files of a datast as a Zip file.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Response[Union[QCrBoxErrorResponse,str]]- Returns:
Response[Union[QCrBoxErrorResponse, str]]
- qcrboxapiclient.api.datasets.download_dataset_by_id.sync(id, *, client)¶
Download a dataset
Download the data files of a datast as a Zip file.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Union[QCrBoxErrorResponse,str,None]- Returns:
Union[QCrBoxErrorResponse, str]
- qcrboxapiclient.api.datasets.download_dataset_by_id.sync_detailed(id, *, client)¶
Download a dataset
Download the data files of a datast as a Zip file.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Response[Union[QCrBoxErrorResponse,str]]- Returns:
Response[Union[QCrBoxErrorResponse, str]]