Class: Api::V2::RequestTypeResource

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

Provides a JSON:API representation of RequestType.

RequestTypes are used by orders to construct requests. The request type identifies the type of Request and associates it with a particular Pipeline. Request types have associated validators to ensure compatible Metadata::Metadata. Request types also associate the request with a particular ProductLine team.

For more information about JSON:API, see the JSON:API Specifications or look at the JSONAPI::Resources package for Sequencescape's implementation.

Examples:

GET request to retrieve all request types

GET /api/v2/request_types/

GET request to retrieve a specific request type by ID

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

#for_multiplexing ⇒ Boolean

Note:

This field is readonly as this resource is immutable.

Returns Whether the request type supports multiplexing.

Returns:

  • (Boolean) —

    Whether the request type supports multiplexing.


46
 
# File 'app/resources/api/v2/request_type_resource.rb', line 46

attribute :for_multiplexing, write_once: true

#key ⇒ String

Note:

This field is readonly as this resource is immutable.

Returns A unique key for the request type.

Returns:

  • (String) —

    A unique key for the request type.


41
 
# File 'app/resources/api/v2/request_type_resource.rb', line 41

attribute :key, write_once: true

#name ⇒ String

Note:

This field is readonly as this resource is immutable.

Returns The name of the request type.

Returns:

  • (String) —

    The name of the request type.


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

attribute :name, write_once: true

#uuid ⇒ String (readonly)

Note:

This field is readonly as this resource is immutable.

Returns The unique identifier of the request type.

Returns:

  • (String) —

    The unique identifier of the request type.


31
 
# File 'app/resources/api/v2/request_type_resource.rb', line 31

attribute :uuid, readonly: true