Class: Api::V2::PlatePurposeResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/plate_purpose_resource.rb

Overview

Note:

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

Note:

This resource cannot be modified after creation: its endpoint will not accept PATCH requests.

The standard Purpose class for plates. Plate purposes categorize plates based on their intended function within the pipeline.

This resource is primarily used by Limber, which registers plate purposes via the API.

}

For more information about JSON:API, see the JSON:API Specifications or the JSONAPI::Resources package, which powers Sequencescape's JSON:API implementation.

Examples:

GET request for all plate purposes

GET /api/v2/plate_purposes/

GET request for a specific plate purpose by ID

GET /api/v2/plate_purposes/123/

POST request to create a new plate purpose

POST /api/v2/plate_purposes/
{
  "data": {
      "type": "plate_purposes",
      "attributes": {
            "name": "API v2 Generated Plate Purpose6",
            "stock_plate": true,
            "cherrypickable_target": false,
            "size": 384,
            "asset_shape": "Standard",
            "input_plate": false
      }
  }

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

#asset_shape ⇒ String

Retrieves the name of the asset shape associated with the plate purpose.

Returns:

  • (String) —

    The name of the asset shape.


85
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 85

attribute :asset_shape

#cherrypickable_target ⇒ Boolean

Dictates whether plates of this purpose can be a destination plate, in Sequencescape's cherrypicking pipeline. Cherry-picking involves transferring specific wells or samples from a plate onto a new plate.

Returns:

  • (Boolean) 

65
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 65

attribute :cherrypickable_target

#input_plate ⇒ Boolean

Determines whether the plate purpose is categorized as an input plate.

Returns:

  • (Boolean) —

    true if the plate purpose is an input plate, otherwise false.


72
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 72

attribute :input_plate

#name ⇒ String

Note:

This attribute is required and must be unique.

The name of the plate purpose.

Returns:

  • (String) 

52
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 52

attribute :name

#size ⇒ Integer

The number of wells in plates of this purpose. Common sizes include 96 and 384 wells.

Returns:

  • (Integer) 

78
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 78

attribute :size

#stock_plate ⇒ Boolean

Indicates whether plates of this purpose are stock plates. Stock plates serve as source plates for further processing. They can be imported via manifest, and are registered in the multi-LIMS warehouse.

Returns:

  • (Boolean) 

59
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 59

attribute :stock_plate

#uuid ⇒ String (readonly)

A unique identifier for the plate purpose. This is automatically assigned upon creation and cannot be modified.

Returns:

  • (String) 

91
 
# File 'app/resources/api/v2/plate_purpose_resource.rb', line 91

attribute :uuid, readonly: true