Class: Api::V2::PreCapturePoolResource

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

Overview

Note:

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

Provides a JSON:API representation of PreCapturePool.

A pre-capture pool is a group of requests which will be pooled together midway through library preparation, particularly prior to capture in the indexed-sequence capture (ISC) pipelines We build pre capture groups at submission so that they are not affected by failing of wells or re-arraying. See Submissions in Sequencescape

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

Examples:

GET request to fetch all pre-capture pools

GET /api/v2/pre_capture_pools/

GET request to fetch a pre-capture pool

GET /api/v2/pre_capture_pools/{id}

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

#uuid ⇒ String (readonly)

Note:

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

The UUID of the pre-capture pool.

Returns:

  • (String) 


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'app/resources/api/v2/pre_capture_pool_resource.rb', line 36

has_metadata do
  # NOTE: The following attribute is not required for Microarray Genotyping.
  # I think this might be broken and suggests that there should be separate classes for project: one for
  # next-gen sequencing that includes this attribute in it's metadata, and one for microarray genotyping
  # that doesn't.
  include ProjectManager::Associations
  include BudgetDivision::Associations

  custom_attribute(:project_cost_code, required: true)
  custom_attribute(:funding_comments)
  custom_attribute(:collaborators)
  custom_attribute(:external_funding_source)
  custom_attribute(:sequencing_budget_cost_centre)
  custom_attribute(:project_funding_model, in: PROJECT_FUNDING_MODELS)
  custom_attribute(:gt_committee_tracking_id)

  before_validation do |record|
    record.project_cost_code = nil if record.project_cost_code.blank?
    record.project_funding_model = nil if record.project_funding_model.blank?
  end
end