CbrainClient::DataProvidersApi

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

Method	HTTP request	Description
data_providers_get	GET /data_providers	Get a list of the Data Providers available to the current user.
data_providers_id_browse_get	GET /data_providers/{id}/browse	List the files on a Data Provider.
data_providers_id_delete_post	POST /data_providers/{id}/delete	Deletes unregistered files from a CBRAIN Data provider.
data_providers_id_get	GET /data_providers/{id}	Get information on a particular Data Provider.
data_providers_id_is_alive_get	GET /data_providers/{id}/is_alive	Pings a Data Provider to check if it is running.
data_providers_id_register_post	POST /data_providers/{id}/register	Registers a file as a Userfile in CBRAIN.
data_providers_id_unregister_post	POST /data_providers/{id}/unregister	Unregisters files as Userfile in CBRAIN.

data_providers_get

Array<DataProvider> data_providers_get(opts)

Get a list of the Data Providers available to the current user.

This method returns a list of Data Provider objects that represent servers with disk space accessible for storing Userfiles.

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::DataProvidersApi.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 Data Providers available to the current user.
  result = api_instance.data_providers_get(opts)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_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<DataProvider>

Authorization

BrainPortalSession

HTTP request headers

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

data_providers_id_browse_get

Array<FileInfo> data_providers_id_browse_get(id)

List the files on a Data Provider.

This method allows the inspection of what files are present on a Data Provider specified by the ID parameter. Files that are not yet registered as Userfiles are visible using this method, as well as regularly accessible Userfiles.

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

id = 56 # Integer | The ID of the Data Provider to browse.


begin
  #List the files on a Data Provider.
  result = api_instance.data_providers_id_browse_get(id)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_browse_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The ID of the Data Provider to browse.

Return type

Array<FileInfo>

Authorization

BrainPortalSession

HTTP request headers

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

data_providers_id_delete_post

RegistrationInfo data_providers_id_delete_post(id, multi_registration_mod_req)

Deletes unregistered files from a CBRAIN Data provider.

This method allows files that have not been registered from CBRAIN to be deleted. This may be necessary if files were uploaded in error, or if they were unregistered but not immediately deleted.

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

id = 56 # Integer | The ID of the Data Provider to delete files from.

multi_registration_mod_req = CbrainClient::MultiRegistrationModReq.new # MultiRegistrationModReq | Arrays containing the files to delete.


begin
  #Deletes unregistered files from a CBRAIN Data provider.
  result = api_instance.data_providers_id_delete_post(id, multi_registration_mod_req)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_delete_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The ID of the Data Provider to delete files from.
multi_registration_mod_req	MultiRegistrationModReq	Arrays containing the files to delete.

Return type

RegistrationInfo

Authorization

BrainPortalSession

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

data_providers_id_get

DataProvider data_providers_id_get(id)

Get information on a particular Data Provider.

This method returns a single Data Provider specified by 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::DataProvidersApi.new

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


begin
  #Get information on a particular Data Provider.
  result = api_instance.data_providers_id_get(id)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_get: #{e}"
end

Parameters

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

Return type

DataProvider

Authorization

BrainPortalSession

HTTP request headers

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

data_providers_id_is_alive_get

String data_providers_id_is_alive_get(id)

Pings a Data Provider to check if it is running.

This method allows the querying of a Data Provider specified by the ID parameter to see if it is running or not.

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

id = 789 # Integer | The ID of the Data Provider to query.


begin
  #Pings a Data Provider to check if it is running.
  result = api_instance.data_providers_id_is_alive_get(id)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_is_alive_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The ID of the Data Provider to query.

Return type

String

Authorization

BrainPortalSession

HTTP request headers

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

data_providers_id_register_post

RegistrationInfo data_providers_id_register_post(id, multi_registration_mod_req)

Registers a file as a Userfile in CBRAIN.

This method allows new files to be added to CBRAIN. The files must first be transfered to the Data Provider via SFTP. For more information on SFTP file transfers, consult the CBRAIN Wiki documentation. Once files are present on the Data Provider, this method registers them in CBRAIN by specifying the file type. You can also specify to copy/move the files to another Data Provider after file registration.

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

id = 56 # Integer | The ID of the Data Provider to register files on.

multi_registration_mod_req = CbrainClient::MultiRegistrationModReq.new # MultiRegistrationModReq | Arrays containing the filenames and types to register.


begin
  #Registers a file as a Userfile in CBRAIN.
  result = api_instance.data_providers_id_register_post(id, multi_registration_mod_req)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_register_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The ID of the Data Provider to register files on.
multi_registration_mod_req	MultiRegistrationModReq	Arrays containing the filenames and types to register.

Return type

RegistrationInfo

Authorization

BrainPortalSession

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

data_providers_id_unregister_post

RegistrationInfo data_providers_id_unregister_post(id, multi_registration_mod_req)

Unregisters files as Userfile in CBRAIN.

This method allows files to be unregistered from CBRAIN. This will not delete the files, but removes them from the CBRAIN database, so Tools may no longer be run on them.

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

id = 56 # Integer | The ID of the Data Provider to unregister files from.

multi_registration_mod_req = CbrainClient::MultiRegistrationModReq.new # MultiRegistrationModReq | Arrays containing the filenames to unregister.


begin
  #Unregisters files as Userfile in CBRAIN.
  result = api_instance.data_providers_id_unregister_post(id, multi_registration_mod_req)
  p result
rescue CbrainClient::ApiError => e
  puts "Exception when calling DataProvidersApi->data_providers_id_unregister_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	The ID of the Data Provider to unregister files from.
multi_registration_mod_req	MultiRegistrationModReq	Arrays containing the filenames to unregister.

Return type

RegistrationInfo

Authorization

BrainPortalSession

HTTP request headers

Content-Type: application/json
Accept: application/json, application/xml

Files

DataProvidersApi.md

Latest commit

History

DataProvidersApi.md

File metadata and controls

CbrainClient::DataProvidersApi

data_providers_get

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_browse_get

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_delete_post

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_is_alive_get

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_register_post

Example

Parameters

Return type

Authorization

HTTP request headers

data_providers_id_unregister_post

Example

Parameters

Return type

Authorization

HTTP request headers