Skip to content

semiweb/techniplast_api

BranchesTags

Repository files navigation

tecniplast

Tecniplast - the Ruby gem for the DVC AMS API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build tecniplast.gemspec

Then either install the gem locally:

gem install ./tecniplast-1.0.0.gem

(for development, run gem install --dev ./tecniplast-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'tecniplast', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'tecniplast', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'tecniplast'

api_instance = Tecniplast::AvailableApi.new
opts = {
  ams_protocol_id: 'ams_protocol_id_example', # String | Filters all cages assigned to the specified protocol
  ams_researcher_id: 'ams_researcher_id_example', # String | Filters all cages belonging to the specified researcher
  ams_mouse_id: 'ams_mouse_id_example', # String | Find the cage with the specified mouse
  ams_rack_id: 'ams_rack_id_example', # String | Find all the cages in this rack
  ams_room_id: 'ams_room_id_example', # String | Find all the cages in this room
  page: 1, # Integer | page number
  size: 1000 # Integer | page size
}

begin
  #This path identifies the operation of searching for one or more cage
  result = api_instance.get_cages(opts)
  p result
rescue Tecniplast::ApiError => e
  puts "Exception when calling AvailableApi->get_cages: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v2

Class Method HTTP request Description
Tecniplast::AvailableApi get_cages GET /inventory/cages This path identifies the operation of searching for one or more cage
Tecniplast::AvailableApi hooks_post POST /hooks By posting on this endpoint you will register a subscriber to the DVC. One subscriber can receive different kinds of events
Tecniplast::AvailableApi inventory_cages_ams_cage_id_bedding_change_full_post POST /inventory/cages/{AmsCageId}/beddingChangeFull report change of full cage (top+bottom)
Tecniplast::AvailableApi inventory_cages_ams_cage_id_bedding_change_partial_post POST /inventory/cages/{AmsCageId}/beddingChangePartial report change of bottom part only
Tecniplast::AvailableApi inventory_cages_ams_cage_id_delete DELETE /inventory/cages/{AmsCageId} Using the DELETE method you can force the dismiss of a cage
Tecniplast::AvailableApi inventory_cages_ams_cage_id_get GET /inventory/cages/{AmsCageId} Get single cage
Tecniplast::AvailableApi inventory_cages_ams_cage_id_led_get GET /inventory/cages/{AmsCageId}/led read led status
Tecniplast::AvailableApi inventory_cages_ams_cage_id_led_put PUT /inventory/cages/{AmsCageId}/led change led state
Tecniplast::AvailableApi inventory_cages_ams_cage_id_put PUT /inventory/cages/{AmsCageId} This path allows the caller to change the data about exactly one cage.
Tecniplast::AvailableApi inventory_cages_post POST /inventory/cages By posting on this endpoint you may force the creation of a cage in the DVC system without requiring any operator action.
Tecniplast::AvailableApi inventory_cages_split_post POST /inventory/cages/split This enables to modify a list of cages in a single transaction
Tecniplast::AvailableApi inventory_racks_ams_rack_id_get GET /inventory/racks/{amsRackId} get rack information
Tecniplast::AvailableApi inventory_racks_ams_rack_id_led_get GET /inventory/racks/{amsRackId}/led get rack LEDs status (top two rows)
Tecniplast::AvailableApi inventory_racks_ams_rack_id_led_put PUT /inventory/racks/{amsRackId}/led activate rack LEDs (top two rows)
Tecniplast::AvailableApi inventory_racks_get GET /inventory/racks get racks information
Tecniplast::AvailableApi inventory_users_get GET /inventory/users get list of users
Tecniplast::AvailableApi inventory_users_post POST /inventory/users create a new user
Tecniplast::AvailableApi inventory_users_username_get GET /inventory/users/{username} get an existing user
Tecniplast::AvailableApi inventory_users_username_put PUT /inventory/users/{username} modify an existing user
Tecniplast::AvailableApi jobs_get GET /jobs get list of tasks planned for today
Tecniplast::AvailableApi jobs_uuid_close_post POST /jobs/{uuid}/close report task completion
Tecniplast::BeddingChangeApi inventory_cages_ams_cage_id_bedding_change_full_post POST /inventory/cages/{AmsCageId}/beddingChangeFull report change of full cage (top+bottom)
Tecniplast::BeddingChangeApi inventory_cages_ams_cage_id_bedding_change_partial_post POST /inventory/cages/{AmsCageId}/beddingChangePartial report change of bottom part only
Tecniplast::CagesApi get_cages GET /inventory/cages This path identifies the operation of searching for one or more cage
Tecniplast::CagesApi inventory_cages_ams_cage_id_delete DELETE /inventory/cages/{AmsCageId} Using the DELETE method you can force the dismiss of a cage
Tecniplast::CagesApi inventory_cages_ams_cage_id_get GET /inventory/cages/{AmsCageId} Get single cage
Tecniplast::CagesApi inventory_cages_ams_cage_id_put PUT /inventory/cages/{AmsCageId} This path allows the caller to change the data about exactly one cage.
Tecniplast::CagesApi inventory_cages_post POST /inventory/cages By posting on this endpoint you may force the creation of a cage in the DVC system without requiring any operator action.
Tecniplast::CagesApi inventory_cages_split_post POST /inventory/cages/split This enables to modify a list of cages in a single transaction
Tecniplast::HooksApi hooks_post POST /hooks By posting on this endpoint you will register a subscriber to the DVC. One subscriber can receive different kinds of events
Tecniplast::LedsApi inventory_cages_ams_cage_id_led_get GET /inventory/cages/{AmsCageId}/led read led status
Tecniplast::LedsApi inventory_cages_ams_cage_id_led_put PUT /inventory/cages/{AmsCageId}/led change led state
Tecniplast::LedsApi inventory_racks_ams_rack_id_led_get GET /inventory/racks/{amsRackId}/led get rack LEDs status (top two rows)
Tecniplast::LedsApi inventory_racks_ams_rack_id_led_put PUT /inventory/racks/{amsRackId}/led activate rack LEDs (top two rows)
Tecniplast::RacksApi inventory_racks_ams_rack_id_get GET /inventory/racks/{amsRackId} get rack information
Tecniplast::RacksApi inventory_racks_ams_rack_id_led_get GET /inventory/racks/{amsRackId}/led get rack LEDs status (top two rows)
Tecniplast::RacksApi inventory_racks_ams_rack_id_led_put PUT /inventory/racks/{amsRackId}/led activate rack LEDs (top two rows)
Tecniplast::RacksApi inventory_racks_get GET /inventory/racks get racks information
Tecniplast::TasksApi jobs_get GET /jobs get list of tasks planned for today
Tecniplast::TasksApi jobs_uuid_close_post POST /jobs/{uuid}/close report task completion
Tecniplast::UsersApi inventory_users_get GET /inventory/users get list of users
Tecniplast::UsersApi inventory_users_post POST /inventory/users create a new user
Tecniplast::UsersApi inventory_users_username_delete DELETE /inventory/users/{username} remove an existing user
Tecniplast::UsersApi inventory_users_username_get GET /inventory/users/{username} get an existing user
Tecniplast::UsersApi inventory_users_username_put PUT /inventory/users/{username} modify an existing user

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

techniplast_client_api

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages