Class: Api::V2::BaitLibraryLayoutResource

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

Overview

Note:

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

Note:

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

Provides a JSON:API representation of BaitLibraryLayout.

This resource represents the layout of bait libraries on a specific plate. It is primarily used to retrieve information about the arrangement of bait libraries.

}

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

Examples:

GET request for all BaitLibraryLayout resources

GET /api/v2/bait_library_layouts/

GET request for a BaitLibraryLayout with ID 123

GET /api/v2/bait_library_layouts/123/

POST request to create a BaitLibraryLayout

POST /api/v2/bait_library_layouts/
{
  "data": {
      "type": "bait_library_layouts",
      "attributes": {
      },
      "relationships": {
          "plate": { "data": { "type": "plates", "id": 1 } },
          "user": { "data": { "type": "users", "id": 4 } }
      }
  }

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

#layout ⇒ Hash (readonly)

Returns The layout of the bait libraries on the plate.

Returns:

  • (Hash) —

    The layout of the bait libraries on the plate.



69
 
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 69

attribute :layout, readonly: true

#plate ⇒ PlateResource

Note:

This relationship is required.

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

Returns:



90
 
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 90

has_one :plate

#plate_uuid=(value) ⇒ void (writeonly)

Deprecated.

Use the plate relationship instead.

This method returns an undefined value.

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

Parameters:

  • value (String) —

    The UUID of the plate for this bait library layout.

See Also:



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

attribute :plate_uuid, writeonly: true

#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 created this bait library layout.



84
 
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 84

has_one :user

#user_uuid=(value) ⇒ void (writeonly)

Deprecated.

Use the user relationship instead.

This method returns an undefined value.

This attribute is declared for convenience when 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 created this bait library layout.

See Also:



61
 
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 61

attribute :user_uuid, writeonly: true

#uuid ⇒ String (readonly)

Note:

This identifier is automatically assigned upon creation and cannot be modified.

Returns The UUID of the bait library layout.

Returns:

  • (String) —

    The UUID of the bait library layout.



74
 
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 74

attribute :uuid, readonly: true