Class: V1::Pacbio::SmrtLinkOptionResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/pacbio/smrt_link_option_resource.rb

Overview

Note:

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

Note:

This resource is read-only; creation, updates, and deletions are not permitted

Provides a JSON:API representation of Pacbio::SmrtLinkOption. This is a resource to return the SMRT link options for a particular SMRT Link version.

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.

via the API.

Examples:

curl -X GET http://localhost:3100/v1/pacbio/smrt_link_options/1
curl -X GET http://localhost:3100/v1/pacbio/smrt_link_options/

Instance Attribute Summary collapse

Instance Attribute Details

#data_typeString

Returns the data type of the SMRT link option.

Returns:

  • (String)

    the data type of the SMRT link option



36
# File 'app/resources/v1/pacbio/smrt_link_option_resource.rb', line 36

attributes :key, :label, :default_value, :data_type, :select_options

#default_valueString

Returns the default value of the SMRT link option.

Returns:

  • (String)

    the default value of the SMRT link option



36
# File 'app/resources/v1/pacbio/smrt_link_option_resource.rb', line 36

attributes :key, :label, :default_value, :data_type, :select_options

#keyString

Returns the key of the SMRT link option.

Returns:

  • (String)

    the key of the SMRT link option



36
# File 'app/resources/v1/pacbio/smrt_link_option_resource.rb', line 36

attributes :key, :label, :default_value, :data_type, :select_options

#labelString

Returns the label of the SMRT link option.

Returns:

  • (String)

    the label of the SMRT link option



36
# File 'app/resources/v1/pacbio/smrt_link_option_resource.rb', line 36

attributes :key, :label, :default_value, :data_type, :select_options

#select_optionsArray<String>

Returns the select options for the SMRT link option.

Returns:

  • (Array<String>)

    the select options for the SMRT link option



36
# File 'app/resources/v1/pacbio/smrt_link_option_resource.rb', line 36

attributes :key, :label, :default_value, :data_type, :select_options