Class: V1::Ont::PlateResource

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

Overview

Note:

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

Provides a JSON:API representation of Plate.

Filters: * barcode - Filter plates by their barcode.

Primary relationships: * wells WellResource - The wells contained in the plate.

Examples:

curl -X GET http://localhost:3100/v1/ont/plates
curl -X GET http://localhost:3100/v1/ont/plates?include=wells
curl -X GET "http://localhost:3100/v1/ont/plates?filter[barcode]=GEN-1762592713-1&include=wells.requests"
curl -X GET "http://localhost:3100/v1/ont/plates?filter[barcode]=GEN-1762592713-1,GEN-1762592713-2"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#barcode ⇒ String

Returns the barcode of the plate.

Returns:

  • (String) —

    the barcode of the plate



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

attributes :barcode

#created_at ⇒ String (readonly)

Returns the creation timestamp of the plate.

Returns:

  • (String) —

    the creation timestamp of the plate



29
 
# File 'app/resources/v1/ont/plate_resource.rb', line 29

attributes :created_at, readonly: true

Class Method Details

.records(_options = {}) ⇒ Object 



38
39
40
 
# File 'app/resources/v1/ont/plate_resource.rb', line 38

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