qcrboxapiclient.api.datasets.get_dataset_by_id

async qcrboxapiclient.api.datasets.get_dataset_by_id.asyncio(id, *, client)

Get dataset by ID

Retrieve a dataset by its ID, including metadata of linked data files.

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, QCrBoxResponseDatasetsResponse, None]

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseDatasetsResponse]

async qcrboxapiclient.api.datasets.get_dataset_by_id.asyncio_detailed(id, *, client)

Get dataset by ID

Retrieve a dataset by its ID, including metadata of linked data files.

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, QCrBoxResponseDatasetsResponse]]

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseDatasetsResponse]]

qcrboxapiclient.api.datasets.get_dataset_by_id.sync(id, *, client)

Get dataset by ID

Retrieve a dataset by its ID, including metadata of linked data files.

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, QCrBoxResponseDatasetsResponse, None]

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseDatasetsResponse]

qcrboxapiclient.api.datasets.get_dataset_by_id.sync_detailed(id, *, client)

Get dataset by ID

Retrieve a dataset by its ID, including metadata of linked data files.

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, QCrBoxResponseDatasetsResponse]]

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseDatasetsResponse]]