Class: V1::QcReceptionResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/qc_reception_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:

Access this resource via the /v1/qc_receptions endpoint.

Provides a JSON:API representation of QcReception.

Steps:

  1. Create QcReception

  2. Create QcResults

  3. Publish qc result messages

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Constant Summary collapse

PERMITTED_QC_FIELDS = 
%w[
  labware_barcode
  sample_external_id
  sheared_femto_fragment_size
  post_spri_concentration
  post_spri_volume
  final_nano_drop_280
  final_nano_drop_230
  final_nano_drop
  shearing_qc_comments
  date_submitted
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#qc_results_list ⇒ Array<Hash>

Returns the list of QC results.

Returns:

  • (Array<Hash>) —

    the list of QC results



37
 
# File 'app/resources/v1/qc_reception_resource.rb', line 37

attributes :qc_results_list, :source

#source ⇒ String

Returns the source of the QC reception.

Returns:

  • (String) —

    the source of the QC reception



37
 
# File 'app/resources/v1/qc_reception_resource.rb', line 37

attributes :qc_results_list, :source

Instance Method Details

#create_qc_results! ⇒ Object

Creates QC results for the model.



37
 
# File 'app/resources/v1/qc_reception_resource.rb', line 37

attributes :qc_results_list, :source

#permitted_attributes ⇒ Array<String>

Returns the list of permitted QC fields.

Returns:

  • (Array<String>) —

    the list of permitted QC fields



37
 
# File 'app/resources/v1/qc_reception_resource.rb', line 37

attributes :qc_results_list, :source

#publish_messages ⇒ Object

Publishes messages for the QC reception.



37
 
# File 'app/resources/v1/qc_reception_resource.rb', line 37

attributes :qc_results_list, :source