Class: Api::V2::TagSetResource

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

Overview

Note:

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

Provides a JSON:API representation of TagSet, which links together two related tag groups. A TagSet represents a logical grouping of tags used for indexing in sequencing experiments. It typically consists of a primary tag group and an optional secondary tag group, enabling support for both single and dual indexing workflows. This resource allows clients to query, filter, and retrieve information about tag sets, including their associated tag groups and metadata, through the /api/v2/tag_sets/ endpoint.

For more information about JSON:API, see the JSON:API Specifications or the JSONAPI::Resources package, which implements JSON:API for Sequencescape.

Examples:

GET request for all TagSet resources

GET /api/v2/tag_sets/

GET request for a specific TagSet by ID

GET /api/v2/tag_sets/123/

Filtering by tag group adapter type name

GET /api/v2/tag_sets/?filter[tag_group_adapter_type_name]=AdapterType1

Filtering by visibility (applied by default)

GET /api/v2/tag_sets/?filter[visible]=true

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

#name ⇒ String (readonly)

The display name of the tag set.

Returns:

  • (String) 


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

attribute :name, readonly: true

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

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:



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

has_one :tag2_group, readonly: true

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

A relationship for the primary tag group associated with the tag layout template.

Returns:



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

has_one :tag_group, readonly: true

#uuid ⇒ String (readonly)

The UUID of the tag set.

Returns:

  • (String) —

    .



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

attribute :uuid, readonly: true