Class: Api::V2::WellResource

Inherits:
BaseResource
  • Object
show all
Includes:
SharedBehaviour::Receptacle
Defined in:
app/resources/api/v2/well_resource.rb

Overview

Note:

Well attributes here are defined in SharedBehaviour::Receptacle

Provides a JSON:API representation of Well.

A Well is a Receptacle on a Plate, it can contain one or more aliquots. A plate may have multiple wells, with the two most common sizes being 128 (96) and 2426 (384). The wells are differentiated via their Map which corresponds to a row and column. Most well locations are identified by a letter-number combination, eg. A1, H12.

Access this resource via the /api/v2/wells/ endpoint.

For more information about JSON:API, see the JSON:API Specifications or look at the JSONAPI::Resources package for Sequencescape's implementation of the JSON:API standard.

Examples:

GET request for all Wells

GET /api/v2/wells/

GET request for a Well with ID 123

GET /api/v2/wells/123/

POST request to create a new Well

POST /api/v2/wells/
{
  "data": {
    "type": "wells",
    "attributes": {
          "pcr_cycles": 12,
        "submit_for_sequencing": false,
        "sub_pool": 2,
        "coverage": 50,
        "diluent_volume": 34.0
    },
    "relationships": {
      "poly_metadata": {
        "data": [{ "type": "poly_metadata", "id": 10 }]
      }
    }
  }
}

PATCH request to update metadata for a Well

PATCH /api/v2/wells/123/
{
  "data": {
    "type": "wells",
    "id": "123",
    "relationships": {
      "poly_metadata": {
        "data": [{ "type": "poly_metadata", "id": "456" }]
      }
    }
  }
}

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseResource

apply_includes, creatable_fields, default_includes, #fetchable_fields, inclusions, resolve_relationship_names_to_relations, updatable_fields

Instance Attribute Details

#poly_metadata ⇒ PolyMetadatumResource (readonly)

Note:

This is a one-to-many relationship, where a well can have multiple pieces of metadata.

Note:

The poly_metadata must already exist in the database before it can be associated with a Well.

Returns The associated metadata for the well.

Returns:

See Also:



86
 
# File 'app/resources/api/v2/well_resource.rb', line 86

has_many :poly_metadata, as: :metadatable, class_name: 'PolyMetadatum'

#position ⇒ Object (readonly) 



75
 
# File 'app/resources/api/v2/well_resource.rb', line 75

attribute :position, readonly: true