Class: V1::AliquotResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::AliquotResource

Defined in:

app/resources/v1/aliquot_resource.rb

Overview

TODO:

This documentation does not yet include a detailed description of what this resource represents.

TODO:

This documentation does not yet include detailed descriptions for relationships, attributes and filters.

TODO:

This documentation does not yet include any example usage of the API via cURL or similar.

Note:

Access this resource via the /v1/aliquots/ endpoint.

Provides a JSON:API representation of Aliquot.

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Direct Known Subclasses

Pacbio::AliquotResource

Instance Attribute Summary

• #aliquot_type ⇒ String

  The type of the aliquot.

• #concentration ⇒ Float

  The concentration of the aliquot.

• #insert_size ⇒ Integer

  The insert size of the aliquot.

• #source_id ⇒ Integer

  The ID of the source.

• #source_type ⇒ String

  The type of the source.

• #state ⇒ String

  The state of the aliquot.

• #tag_id ⇒ Integer

  The ID of the tag associated with the aliquot.

• #template_prep_kit_box_barcode ⇒ String

  The barcode of the template prep kit box.

• #used_by_id ⇒ Integer

  The ID of the entity that used the aliquot.

• #used_by_type ⇒ String

  The type of the entity that used the aliquot.

• #volume ⇒ Float

  The volume of the aliquot.

Instance Attribute Details

#aliquot_type ⇒ String

Returns the type of the aliquot.

Returns:

• (String) —

  the type of the aliquot

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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