Class: V1::Ont::FlowcellResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/ont/flowcell_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/ont/flowcells/ endpoint.

Provides a JSON:API representation of Ont::Flowcell.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#flowcell_idInteger

Returns the ID of the flowcell.

Returns:

  • (Integer)

    the ID of the flowcell


25
# File 'app/resources/v1/ont/flowcell_resource.rb', line 25

attributes :flowcell_id, :position, :ont_pool_id

#ont_pool_idInteger

Returns the ID of the ONT pool.

Returns:

  • (Integer)

    the ID of the ONT pool


25
# File 'app/resources/v1/ont/flowcell_resource.rb', line 25

attributes :flowcell_id, :position, :ont_pool_id

#positionString

Returns the position of the flowcell.

Returns:

  • (String)

    the position of the flowcell


25
# File 'app/resources/v1/ont/flowcell_resource.rb', line 25

attributes :flowcell_id, :position, :ont_pool_id