Class: Api::V2::TagLayoutResource

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

Provides a JSON:API representation of TagLayout.

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

#direction ⇒ String

Note:

This attribute is required.

The name of the algorithm defining the direction of the tag layout.

Returns:

  • (String) 


26
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 26

attribute :direction

#enforce_uniqueness=(value) ⇒ Object (writeonly)

A flag indicating whether to set enforce_uniqueness on TagLayout::TemplateSubmissions when a template is used to create the TagLayout.

Parameters:

  • value (Boolean) —

    Whether to enforce uniqueness within template submissions.



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

attribute :enforce_uniqueness, writeonly: true

#initial_tag ⇒ Integer

An offset for the tag set indicating which tag to start with in the layout.

Returns:

  • (Integer) 


42
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 42

attribute :initial_tag

#plate ⇒ Api::V2::PlateResource

Note:

This relationship is required.

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

Returns:



147
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 147

has_one :plate

#plate_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the plate relationship instead.

This is declared for convenience where 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 this tag layout applies to.

Returns:

  • (Void)

See Also:



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

attribute :plate_uuid, writeonly: true

#substitutions ⇒ Hash

A hash of substitutions to be applied to the tag layout.

Returns:

  • (Hash) 


60
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 60

attribute :substitutions

#tag2_group ⇒ Api::V2::TagGroupResource

Setting this relationship alongside the tag2_group_uuid attribute will override the attribute value. A relationship for the secondary tag group associated with the tag layout template. This is used during dual indexing, but will not be found during single indexing.

Returns:



161
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 161

has_one :tag2_group, class_name: 'TagGroup'

#tag2_group_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the tag2_group relationship instead.

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

Parameters:

  • value (String) —

    The UUID of the second TagGroup used in this tag layout.

Returns:

  • (Void)

See Also:



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

attribute :tag2_group_uuid, writeonly: true

#tag_group ⇒ Api::V2::TagGroupResource

Note:

This relationship is required.

Setting this relationship alongside the tag_group_uuid attribute will override the attribute value. A relationship for the primary tag group associated with the tag layout template.

Returns:



154
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 154

has_one :tag_group

#tag_group_uuid=(value) ⇒ Void (writeonly)

Deprecated.

Use the tag_group relationship instead.

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

Parameters:

  • value (String) —

    The UUID of the TagGroup used in this tag layout.

Returns:

  • (Void)

See Also:



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

attribute :tag_group_uuid, writeonly: true

#tag_layout_template_uuid=(value) ⇒ Object (writeonly)

Parameters:

  • value (String) —

    the UUID of a TagLayoutTemplate to use for attributes of this TagLayout resource. Providing this UUID while also providing values for attributes and relationships which can be extracted from a Api::V2::TagLayoutTemplateResource will generate an error indicating that the UUID should not have been provided.



101
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 101

attribute :tag_layout_template_uuid, writeonly: true

#tags_per_well ⇒ Integer

The number of tags in each well. This is only used and/or returned by specific tag layout #walking_by algorithms. At other times, this value will be nil.

Returns:

  • (Integer) 


114
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 114

attribute :tags_per_well

#user ⇒ Api::V2::UserResource

Note:

This relationship is required.

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

Returns:



167
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 167

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 this state change.

Returns:

  • (Void)

See Also:



123
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 123

attribute :user_uuid, writeonly: true

#uuid ⇒ String (readonly)

Returns The UUID of the state change.

Returns:

  • (String) —

    The UUID of the state change.



131
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 131

attribute :uuid, readonly: true

#walking_by ⇒ String

Note:

This attribute is required.

The name of the algorithm defining the way of walking through the tag layout.

Returns:

  • (String) 


137
 
# File 'app/resources/api/v2/tag_layout_resource.rb', line 137

attribute :walking_by