Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.86 KB

ToolsApi.md

File metadata and controls

66 lines (45 loc) · 1.86 KB
Raw

CbrainClient::ToolsApi

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

Method HTTP request Description
tools_get GET /tools Get the list of Tools.

tools_get

Array<Tool> tools_get(opts)

Get the list of Tools.

This method returns a list of all of the Tools that exist in CBRAIN. Tools encapsulate a scientific program designed to extract information from an input Userfile.

Example

# load the gem
require 'cbrain_client'
# setup authorization
CbrainClient.configure do |config|
  # Configure API key authorization: BrainPortalSession
  config.api_key['cbrain_api_token'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['cbrain_api_token'] = 'Bearer'
end

api_instance = CbrainClient::ToolsApi.new

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

begin
  #Get the list of Tools.
  result = api_instance.tools_get(opts)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling ToolsApi->tools_get: #{e}"
end

Parameters

Name Type Description Notes
page Integer Page number when paginating. See also the per_page parameter [optional]
per_page Integer Size of each page when paginating. See also the page parameter [optional]

Return type

Array<Tool>

Authorization

BrainPortalSession

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json, application/xml