Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 2.2 KB

ToolsApi.md

File metadata and controls

65 lines (45 loc) · 2.2 KB

cbrain_api.ToolsApi

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

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

tools_get

list[Tool] tools_get(page=page, per_page=per_page)

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

from __future__ import print_function
import time
import cbrain_api
from cbrain_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: BrainPortalSession
configuration = cbrain_api.Configuration()
configuration.api_key['cbrain_api_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cbrain_api_token'] = 'Bearer'

# create an instance of the API class
api_instance = cbrain_api.ToolsApi(cbrain_api.ApiClient(configuration))
page = 56 # int | Page number when paginating. See also the per_page parameter (optional)
per_page = 56 # int | Size of each page when paginating. See also the page parameter (optional)

try:
    # Get the list of Tools.
    api_response = api_instance.tools_get(page=page, per_page=per_page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ToolsApi->tools_get: %s\n" % e)

Parameters

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

Return type

list[Tool]

Authorization

BrainPortalSession

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]