Skip to content

Latest commit

 

History

History
121 lines (82 loc) · 3.37 KB

BourreauxApi.md

File metadata and controls

121 lines (82 loc) · 3.37 KB
Raw

CbrainClient::BourreauxApi

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

Method HTTP request Description
bourreaux_get GET /bourreaux Get a list of the Bourreaux available to be used by the current user.
bourreaux_id_get GET /bourreaux/{id} Get information about a Bourreau.

bourreaux_get

Array<Bourreau> bourreaux_get(opts)

Get a list of the Bourreaux available to be used by the current user.

This method returns a list of Bourreau objects.

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::BourreauxApi.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 a list of the Bourreaux available to be used by the current user.
  result = api_instance.bourreaux_get(opts)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling BourreauxApi->bourreaux_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<Bourreau>

Authorization

BrainPortalSession

HTTP request headers

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

bourreaux_id_get

Bourreau bourreaux_id_get(id)

Get information about a Bourreau.

This method returns a single Bourreau object based on the ID parameter.

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::BourreauxApi.new

id = 56 # Integer | ID of the Bourreau to get information on.


begin
  #Get information about a Bourreau.
  result = api_instance.bourreaux_id_get(id)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling BourreauxApi->bourreaux_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer ID of the Bourreau to get information on.

Return type

Bourreau

Authorization

BrainPortalSession

HTTP request headers

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