Class: Api::V2::PooledPlateCreationResource

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

Provides a JSON:API representation of PooledPlateCreation.

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

#child ⇒ PlateResource (readonly)

Returns The child plate which was created.

Returns:



67
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 67

has_one :child, class_name: 'Plate', readonly: true

#child_purpose_uuid=(value) ⇒ Void (writeonly)

Parameters:

  • value (String) —

    The UUID of a child purpose to use in the creation of the child plate.

Returns:

  • (Void) 


25
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 25

attribute :child_purpose_uuid, writeonly: true

#parent_uuids=(value) ⇒ Void (writeonly)

Deprecated.

Use the parents relationship instead.

This is declared for convenience where parents are not available to set as a relationship. Setting this attribute alongside the parents relationship will prefer the relationship value.

Parameters:

  • value (Array<String>) —

    The UUIDs of labware that will be the parents for the created plate.

Returns:

  • (Void)

See Also:



38
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 38

attribute :parent_uuids, writeonly: true

#parents ⇒ Array<LabwareResource>

Note:

This relationship is required.

Setting this relationship alongside the parent_uuids attribute will override the attribute value.

Returns:

  • (Array<LabwareResource>) —

    An array of the parents of the plate being created.



73
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 73

has_many :parents, class_name: 'Labware'

#user ⇒ UserResource

Note:

This relationship is required.

Setting this relationship alongside the user_uuid attribute will override the attribute value.

Returns:

  • (UserResource) —

    The user who initiated the creation of the pooled plate.



79
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 79

has_one :user

#user_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the user relationship instead.

This is declared for convenience where the user is not available to set as a relationship. Setting this attribute alongside the user relationship will prefer the relationship value.

Parameters:

  • value (String) —

    The UUID of the user who initiated the creation of this pooled plate.

Returns:

  • (Void)

See Also:



51
 
# File 'app/resources/api/v2/pooled_plate_creation_resource.rb', line 51

attribute :user_uuid, writeonly: true

#uuid ⇒ String (readonly)

Returns The UUID of the pooled plate creation.

Returns:

  • (String) —

    The UUID of the pooled plate creation.



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

attribute :uuid, readonly: true