Class: V1::Ont::FlowcellResource

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

Overview

Note:

Access this resource via the /v1/ont/flowcells/ endpoint.

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

Primary relationships: * pool PoolResource - The pool loaded onto the flowcell.

Examples:

curl -X GET http://localhost:3100/v1/ont/flowcells
curl -X GET "http://localhost:3100/v1/ont/flowcells/1"

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