Class: Api::V2::TagResource

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

Overview

Note:

This resource is immutable: its endpoint will not accept POST, PATCH, or DELETE requests.

Note:

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

Provides a JSON:API representation of Tag.

A Tag is a short, know sequence of DNA which gets applied to a sample. The tag remains attached through subsequent processing, and means that it is possible to identify the origin of a sample if multiple samples are subsequently pooled together. Tags are sometimes referred to as barcodes by our users. Tag is stored on aliquot, and an individual aliquot can have two tags identified as tag and tag2, these may also be known as i7 and i5 respectively.

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.

Examples:

GET request for all tags

GET /api/v2/tags/

GET request for a tag with ID 123

GET /api/v2/tags/123/

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

#map_id ⇒ String

Note:

This attribute is required when creating a tag.

The ID of the map associated with the tag. This attribute is write-once, meaning it cannot be updated after creation.

Returns:

  • (String) —

    The ID of the associated map.



39
 
# File 'app/resources/api/v2/tag_resource.rb', line 39

attribute :map_id, write_once: true

#oligo ⇒ String

Note:

This attribute is required when creating a tag.

The oligo sequence associated with the tag. This attribute is write-once, meaning it cannot be updated after creation.

Returns:

  • (String) —

    The oligo sequence associated with the tag.



46
 
# File 'app/resources/api/v2/tag_resource.rb', line 46

attribute :oligo, write_once: true

#tag_group ⇒ Api::V2::TagGroupResource (readonly)

The relationship to the tag group associated with this tag. A tag belongs to one specific tag group.

Returns:



55
 
# File 'app/resources/api/v2/tag_resource.rb', line 55

has_one :tag_group