Class: Api::V2::SubmissionTemplateResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/submission_template_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_templates/ endpoint.

Provides a JSON:API representation of SubmissionTemplate.

A SubmissionTemplate associates a name to a pre-filled submission (subclass) and a serialized set of attributes A SubmissionTemplate is typically used to standardize submission parameters, making it easier to create new submissions with predefined settings. Users can retrieve submission templates to understand their configurations.

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

GET /api/v2/submission_templates/

GET request for a SubmissionTemplate with a specific ID

GET /api/v2/submission_templates/{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

#name ⇒ String (readonly)

Returns The name of the submission template.

Returns:

  • (String) —

    The name of the submission template.



40
 
# File 'app/resources/api/v2/submission_template_resource.rb', line 40

attribute :name

#uuid ⇒ String (readonly)

Note:

This identifier is automatically assigned and cannot be modified.

Returns The UUID of the submission template.

Returns:

  • (String) —

    The UUID of the submission template.



36
 
# File 'app/resources/api/v2/submission_template_resource.rb', line 36

attribute :uuid, readonly: true