ToolsApi.md

Swagger\Client\ToolsApi

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

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

toolsGet

\Swagger\Client\Model\Tool[] toolsGet($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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: BrainPortalSession
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('cbrain_api_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('cbrain_api_token', 'Bearer');

$apiInstance = new Swagger\Client\Api\ToolsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 56; // int | Page number when paginating. See also the per_page parameter
$per_page = 56; // int | Size of each page when paginating. See also the page parameter

try {
    $result = $apiInstance->toolsGet($page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ToolsApi->toolsGet: ', $e->getMessage(), PHP_EOL;
}
?>

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

\Swagger\Client\Model\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]