Class: Api::V2::SubmissionPoolResource

Inherits:

BaseResource

Object
JSONAPI::Resource
BaseResource
Api::V2::SubmissionPoolResource

show all

Defined in:: app/resources/api/v2/submission_pool_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/submission_pools/ endpoint.

Provides a JSON:API representation of a SubmissionPool. SubmissionPools are designed to view submissions in the context of a particular labware.

Provides a JSON:API representation of SubmissionPool.

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 SubmissionPool resources

GET /api/v2/submission_pools/

GET request for a SubmissionPool with ID 123

GET /api/v2/submission_pools/123/

Instance Attribute Summary collapse

#plates_in_submission ⇒ Integer readonly

The number of plates in the submission pool.
#tag_layout_templates ⇒ Array<TagLayoutTemplateResource> readonly

The tag layout templates for this submission pool.

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

#plates_in_submission ⇒ `Integer` (readonly)

Returns The number of plates in the submission pool.

Returns:

(Integer) —

The number of plates in the submission pool.

27	# File 'app/resources/api/v2/submission_pool_resource.rb', line 27 attribute :plates_in_submission, readonly: true

#tag_layout_templates ⇒ `Array<TagLayoutTemplateResource>` (readonly)

Returns The tag layout templates for this submission pool.