Class: V1::AliquotResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/aliquot_resource.rb

Overview

Note:

This resource cannot be directly accessed via the /v1/aliquots/ endpoint

Provides a JSON:API representation of Aliquot.

as it is only accessible via the nested route under other resources using includes.

Direct Known Subclasses

Pacbio::AliquotResource

Instance Attribute Summary collapse

Instance Attribute Details

#aliquot_type ⇒ String

Returns the type of the aliquot.

Returns:

  • (String) —

    the type of the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#concentration ⇒ Float

Returns the concentration of the aliquot.

Returns:

  • (Float) —

    the concentration of the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#insert_size ⇒ Integer

Returns the insert size of the aliquot.

Returns:

  • (Integer) —

    the insert size of the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#source_id ⇒ Integer

Returns the ID of the source.

Returns:

  • (Integer) —

    the ID of the source



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#source_type ⇒ String

Returns the type of the source.

Returns:

  • (String) —

    the type of the source



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#state ⇒ String

Returns the state of the aliquot.

Returns:

  • (String) —

    the state of the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#tag_id ⇒ Integer

Returns the ID of the tag associated with the aliquot.

Returns:

  • (Integer) —

    the ID of the tag associated with the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#template_prep_kit_box_barcode ⇒ String

Returns the barcode of the template prep kit box.

Returns:

  • (String) —

    the barcode of the template prep kit box



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#used_by_id ⇒ Integer

Returns the ID of the entity that used the aliquot.

Returns:

  • (Integer) —

    the ID of the entity that used the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#used_by_type ⇒ String

Returns the type of the entity that used the aliquot.

Returns:

  • (String) —

    the type of the entity that used the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id

#volume ⇒ Float

Returns the volume of the aliquot.

Returns:

  • (Float) —

    the volume of the aliquot



36
37
 
# File 'app/resources/v1/aliquot_resource.rb', line 36

attributes :aliquot_type, :source_id, :source_type, :used_by_id, :used_by_type, :state,
:volume, :concentration, :insert_size, :template_prep_kit_box_barcode, :tag_id