Class: V1::Pacbio::PlateResource

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

Provides a JSON:API representation of Plate.

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

Class Method Summary collapse

Instance Attribute Details

#barcodeString

Returns the barcode of the plate.

Returns:

  • (String)

    the barcode of the plate



23
# File 'app/resources/v1/pacbio/plate_resource.rb', line 23

attributes :barcode, :created_at

#created_atString

Returns the creation time of the plate.

Returns:

  • (String)

    the creation time of the plate



23
# File 'app/resources/v1/pacbio/plate_resource.rb', line 23

attributes :barcode, :created_at

Class Method Details

.default_sortObject



29
30
31
# File 'app/resources/v1/pacbio/plate_resource.rb', line 29

def self.default_sort
  [{ field: 'created_at', direction: :desc }]
end

.records(_options = {}) ⇒ Object



35
36
37
# File 'app/resources/v1/pacbio/plate_resource.rb', line 35

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