cbrain_client

CbrainClient - the Ruby gem for the CBRAIN API

API for interacting with the CBRAIN Platform

This SDK is automatically generated by the Swagger Codegen project:

• API version: 7.0.0
• Package version: 7.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/aces/cbrain

Installation

Build a gem

To build the Ruby code into a gem:

shell gem build cbrain_client.gemspec

Then either install the gem locally:

shell gem install ./cbrain_client-7.0.0.gem (for development, run gem install --dev ./cbrain_client-7.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 'cbrain_client', '~> 7.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/aces/cbrain-client-gem, then add the following in the Gemfile:

gem 'cbrain_client', :git => 'https://github.com/aces/cbrain-client-gem'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

shell ruby -Ilib script.rb

Getting Started

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

Load the gem

require 'cbrain_client'

Setup authorization

CbrainClient.configure do |config| # Configure API key authorization: BrainPortalSession config.apikey['cbrainapitoken'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.apikeyprefix['cbrainapi_token'] = 'Bearer' end

api_instance = CbrainClient::BourreauxApi.new

opts = { page: 56, # Integer | Page number when paginating. See also the perpage parameter perpage: 56 # Integer | Size of each page when paginating. See also the page parameter }

begin #Get a list of the Bourreaux available to be used by the current user. result = apiinstance.bourreauxget(opts) p result rescue CbrainClient::ApiError => e puts "Exception when calling BourreauxApi->bourreaux_get: #{e}" end

```

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CbrainClient::BourreauxApi | bourreaux_get | GET /bourreaux | Get a list of the Bourreaux available to be used by the current user. CbrainClient::BourreauxApi | bourreauxidget | GET /bourreaux/{id} | Get information about a Bourreau. CbrainClient::DataProvidersApi | dataprovidersget | GET /dataproviders | Get a list of the Data Providers available to the current user. CbrainClient::DataProvidersApi | dataprovidersidbrowseget | GET /dataproviders/{id}/browse | List the files on a Data Provider. CbrainClient::DataProvidersApi | dataprovidersiddeletepost | POST /dataproviders/{id}/delete | Deletes unregistered files from a CBRAIN Data provider. CbrainClient::DataProvidersApi | dataprovidersid_get | GET /dataproviders/{id} | Get information on a particular Data Provider. CbrainClient::DataProvidersApi | dataprovidersidisalive_get | GET /dataproviders/{id}/isalive | Pings a Data Provider to check if it is running. CbrainClient::DataProvidersApi | dataprovidersidregisterpost | POST /dataproviders/{id}/register | Registers a file as a Userfile in CBRAIN. CbrainClient::DataProvidersApi | dataprovidersidunregisterpost | POST /dataproviders/{id}/unregister | Unregisters files as Userfile in CBRAIN. CbrainClient::GroupsApi | groups_get | GET /groups | Get a list of the Groups (projects) available to the current user. CbrainClient::GroupsApi | groupsiddelete | DELETE /groups/{id} | Deletes a Group (project). CbrainClient::GroupsApi | groupsidget | GET /groups/{id} | Get information on a Group (project). CbrainClient::GroupsApi | groupsidput | PUT /groups/{id} | Update the properties of a Group (project). CbrainClient::GroupsApi | groups_post | POST /groups | Creates a new Group. CbrainClient::SessionsApi | session_delete | DELETE /session | Destroy the current session CbrainClient::SessionsApi | session_get | GET /session | Get session information CbrainClient::SessionsApi | session_post | POST /session | Create a new session CbrainClient::TagsApi | tags_get | GET /tags | Get a list of the tags currently in CBRAIN. CbrainClient::TagsApi | tagsiddelete | DELETE /tags/{id} | Delete a tag. CbrainClient::TagsApi | tagsidget | GET /tags/{id} | Get one tag. CbrainClient::TagsApi | tagsidput | PUT /tags/{id} | Update a tag. CbrainClient::TagsApi | tags_post | POST /tags | Create a new tag. CbrainClient::TasksApi | tasks_get | GET /tasks | Get the list of Tasks. CbrainClient::TasksApi | tasksidget | GET /tasks/{id} | Get information on a Task. CbrainClient::TasksApi | tasksoperationpost | POST /tasks/operation | Control and apply operation to a set of tasks CbrainClient::TasksApi | tasks_post | POST /tasks | Create a new Task. CbrainClient::ToolConfigsApi | toolconfigsget | GET /toolconfigs | Get a list of tool versions installed. CbrainClient::ToolConfigsApi | toolconfigsid_get | GET /toolconfigs/{id} | Get information about a particular tool configuration CbrainClient::ToolsApi | tools_get | GET /tools | Get the list of Tools. CbrainClient::UserfilesApi | userfileschangeprovider_post | POST /userfiles/changeprovider | Moves the Userfiles from their current Data Provider to a new one. CbrainClient::UserfilesApi | userfilescompresspost | POST /userfiles/compress | Compresses many Userfiles each into their own GZIP archive. CbrainClient::UserfilesApi | userfilesdeletefiles_delete | DELETE /userfiles/deletefiles | Delete several files that have been registered as Userfiles CbrainClient::UserfilesApi | userfilesdownloadpost | POST /userfiles/download | Download several files CbrainClient::UserfilesApi | userfiles_get | GET /userfiles | List of the Userfiles accessible to the current user. CbrainClient::UserfilesApi | userfilesidcontent_get | GET /userfiles/{id}/content | Get the content of a Userfile CbrainClient::UserfilesApi | userfilesidget | GET /userfiles/{id} | Get information on a Userfile. CbrainClient::UserfilesApi | userfilesidput | PUT /userfiles/{id} | Update information on a Userfile. CbrainClient::UserfilesApi | userfiles_post | POST /userfiles | Creates a new Userfile and upload its content. CbrainClient::UserfilesApi | userfilessyncmultiple_post | POST /userfiles/sync_multiple | Syncs Userfiles to the local Data Providers cache. CbrainClient::UserfilesApi | userfilesuncompresspost | POST /userfiles/uncompress | Uncompresses many Userfiles. CbrainClient::UsersApi | users_get | GET /users | Returns all of the users in CBRAIN. Only available to admins. CbrainClient::UsersApi | usersiddelete | DELETE /users/{id} | Deletes a CBRAIN user CbrainClient::UsersApi | usersidget | GET /users/{id} | Returns information about a user CbrainClient::UsersApi | usersidpatch | PATCH /users/{id} | Update information about a user CbrainClient::UsersApi | users_post | POST /users | Create a new user in CBRAIN. Only available to admins.

Documentation for Models

• CbrainClient::BatchTaskModReq
• CbrainClient::Bourreau
• CbrainClient::CbrainTask
• CbrainClient::CbrainTaskModReq
• CbrainClient::DataProvider
• CbrainClient::FileInfo
• CbrainClient::Group
• CbrainClient::GroupModReq
• CbrainClient::MultiRegistrationModReq
• CbrainClient::MultiUserfilesModReq
• CbrainClient::RegistrationInfo
• CbrainClient::SessionInfo
• CbrainClient::Tag
• CbrainClient::TagModReq
• CbrainClient::Tool
• CbrainClient::ToolConfig
• CbrainClient::User
• CbrainClient::UserModReq
• CbrainClient::Userfile
• CbrainClient::UserfileModReq

Documentation for Authorization

BrainPortalSession

• Type: API key
• API key parameter name: cbrainapitoken
• Location: URL query string