Class: Api::V2::PlatePurposeResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/plate_purpose_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:

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

Note:

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

Provides a JSON:API representation of PlatePurpose.

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.

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

Returns the name of the asset shape of the plate purpose. The asset_shape association is not utilized in Limber. This method returns the name of the asset shape associated with the plate purpose.

Returns:

  • (String) —

    the name of the asset shape



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

attribute :asset_shape

#cherrypickable_target ⇒ Boolean

Returns whether the plates of this purpose are cherrypickable.

Returns:

  • (Boolean) —

    whether the plates of this purpose are cherrypickable.



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

attribute :cherrypickable_target

#input_plate ⇒ Boolean

Returns the input_plate attribute from the type of the plate purpose.

Returns:

  • (Boolean) —

    whether the plate purpose is an input plate.



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

attribute :input_plate

#name ⇒ String

Returns the name of the plate purpose.

Returns:

  • (String) —

    the name of the plate purpose.



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

attribute :name

#size ⇒ Integer

Returns the size of the plates of this purpose.

Returns:

  • (Integer) —

    the size of the plates of this purpose.



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

attribute :size

#stock_plate ⇒ Boolean

Returns whether the plates of this purpose are stock plates.

Returns:

  • (Boolean) —

    whether the plates of this purpose are stock plates.



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

attribute :stock_plate

#uuid ⇒ String (readonly)

Returns the UUID of the plate purpose.

Returns:

  • (String) —

    the UUID of the plate purpose.



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

attribute :uuid, readonly: true