mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples module

mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples module#

async mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples.asyncio(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List Samples associated with this Study

List all samples associated with this study.

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:

NinjaPaginationResponseSchemaMGnifySampleWithMetadata

Return type:

NinjaPaginationResponseSchemaMGnifySampleWithMetadata | None

async mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples.asyncio_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List Samples associated with this Study

List all samples associated with this study.

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifySampleWithMetadata]

mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples.sync(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List Samples associated with this Study

List all samples associated with this study.

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:

NinjaPaginationResponseSchemaMGnifySampleWithMetadata

Return type:

NinjaPaginationResponseSchemaMGnifySampleWithMetadata | None

mgnipy.emgapi_v2_client.api.studies.list_mgnify_study_samples.sync_detailed(accession, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List Samples associated with this Study

List all samples associated with this study.

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

Return type:

Response[NinjaPaginationResponseSchemaMGnifySampleWithMetadata]

Contents