Class: V1::Pacbio::TubeResource

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

Overview

Note:

Access this resource via the /v1/pacbio/tubes/ endpoint.

Provides a JSON:API representation of Tube.

Filters: * barcode

Primary relationships: * materials ContainerMaterialResource * pools PoolResource * library LibraryResource * requests RequestResource

Examples:

curl -X GET http://localhost:3100/v1/pacbio/tubes/
curl -X GET http://localhost:3100/v1/pacbio/tubes?filter[barcode]=GEN-1762592703-6"
curl -X GET http://localhost:3100/v1/pacbio/tubes?filter[barcode]=GEN-1762592703-6&include=materials,pools,libraries,requests
curl -X GET http://localhost:3100/v1/pacbio/tubes?&filter[barcode]=TRAC-2-20172&include=pools.libraries.request,pools.requests,pools.used_aliquots.tag,libraries.used_aliquots.request,libraries.used_aliquots.tag&fields[requests]=sample_name&fields[tags]=group_id

Direct Known Subclasses

Runs::TubeResource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#barcode ⇒ String

Returns the barcode of the tube.

Returns:

  • (String) —

    the barcode of the tube



29
 
# File 'app/resources/v1/pacbio/tube_resource.rb', line 29

attributes :barcode

Class Method Details

.records(_options = {}) ⇒ Object 



41
42
43
 
# File 'app/resources/v1/pacbio/tube_resource.rb', line 41

def self.records(_options = {})
  ::Tube.by_pipeline(:pacbio)
end