Class: V1::Pacbio::WellResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::Pacbio::WellResource

Defined in:

app/resources/v1/pacbio/well_resource.rb

Overview

Note:

Access this resource via the /v1/pacbio/wells/ endpoint.

Provides a JSON:API representation of Pacbio::Well.

This resource is primarily accessed through RunResource and PlateResource. Wells are primarily created via a Run and Plate.

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.

This resource represents a Pacbio Well and can return all wells or a single well

This resource has no filters.

Primary relationships:

• materials MaterialResource

• requests RequestResource

• plate PlateResource

Examples:

curl -X GET http://localhost:3000/v1/pacbio/wells/1
curl -X GET http://localhost:3000/v1/pacbio/wells
curl -X GET http://localhost:3000/v1/pacbio/runs/1/wells
curl -X GET http://localhost:3000/v1/pacbio/runs/1/wells/1

https://localhost:3000/v1/pacbio/v1/wells/1?include=plate,materials

Instance Attribute Summary

• #position ⇒ String

  The position of the well.

Instance Attribute Details

#position ⇒ String

Returns the position of the well.

Returns:

• (String) —

  the position of the well

# File 'app/resources/v1/pacbio/well_resource.rb', line 40

attributes :position